Skip to content

Commit c60a1d2

Browse files
author
Kazarus4
committed
Carbon footprint EN integrations for all subs done
1 parent cd5c716 commit c60a1d2

File tree

12 files changed

+978
-6
lines changed

12 files changed

+978
-6
lines changed
Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
---
2+
title: "How to obtain the carbon footprint of your OVHcloud services"
3+
excerpt: "Find out how to retrieve the monthly carbon footprint of your OVHcloud services using our carbon calculator"
4+
updated: 2025-04-22
5+
---
6+
7+
## Objective
8+
9+
As part of your professional activities or out of interest on the subject, you may need to calculate the carbon footprint of your services.
10+
11+
**Find out how to retrieve the monthly carbon footprint of your OVHcloud services.**
12+
13+
## Requirements
14+
15+
- Being the billing contact for the service(s) you would like to create a carbon footprint for. For more information, see [our guide to managing contacts](/pages/account_and_service_management/account_information/managing_contacts).
16+
17+
**The carbon footprint calculation is available for the following services:**
18+
19+
- [Dedicated Server](/links/bare-metal/bare-metal) (Advance, Game, Scale, High Grade, Storage)
20+
- [Eco Dedicated Server](/links/bare-metal/eco) (Rise, Kimsufi, So You Start)
21+
- [VMware on OVHcloud](/links/hosted-private-cloud/vmware)
22+
- [Public Cloud Instances (Compute)](/links/public-cloud/compute)
23+
24+
## Instructions
25+
26+
Please note the following information:
27+
28+
- You cannot generate a carbon footprint report for the current month.
29+
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30+
- No carbon footprint report can be generated for more than the last 24 months.
31+
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
32+
33+
| Service | Date of commissioning of the carbon footprint calculator |
34+
|------------------------|----------------------------------------------------------|
35+
| Dedicated Server | 2023/05/01 |
36+
| Eco Dedicated Server | 2023/05/01 |
37+
| VMware on OVHcloud | 2023/08/01 |
38+
| Public Cloud Instances | 2025/01/01 |
39+
40+
### Retrieving the monthly carbon footprint report for the previous month via the OVHcloud Control Panel
41+
42+
1. Log in to the [OVHcloud Control Panel](/links/manager).
43+
1. On the page that opens, scroll down to the **Useful links** section in the left-hand column, then click on the `My carbon footprint`{.action} tab.
44+
1. On the new page that appears, click `Download my [Month] [Year] footprint`{.action}.
45+
46+
![Carbon footprint](/pages/assets/screens/control_panel/product-selection/right-column/carbon-footprint/my-carbon-footprint.png){.thumbnail}
47+
48+
You can recover the carbon footprint of the previous month for your eligible services every month.
49+
50+
If you need the carbon footprint for a month prior to the month preceding the current month, you will have to use our APIs to retrieve it.
51+
52+
### Retrieving a monthly carbon footprint prior to the previous month via our APIs
53+
54+
By default, OVHcloud APIs are made available to developers or integrators to associate features, such as those not present in the OVHcloud Control Panel, directly with their applications or solutions.
55+
56+
### Step 1 - Log in to the OVHcloud APIs
57+
58+
- Go to our [OVHcloud API](/links/api) website (check that you are on `https://eu.api.ovh.com` if your services are hosted in Europe, and on `https://ca.api.ovh.com` if they are hosted outside Europe).
59+
- On the page that pops up, click `Explore the OVHcloud API`{.action}.
60+
- On the left-hand side of the new page that appears, go to the form to the right of the `v1`{.action} field, then select/enter the choice `/me`.
61+
- From the list of APIs that appear below in the left-hand column, locate and click the following API: **POST /me/carbonCalculator/task**. You can also access it directly via the API call below:
62+
63+
> [!api]
64+
>
65+
> @api {v1} /me POST /me/carbonCalculator/task
66+
>
67+
68+
- On the right-hand side of the page, you will then see the API with its fields to complete.
69+
- Click the button in the top right-hand corner labeled `Authenticate`{.action}, then the `Login with OVHcloud SSO`{.action} button.
70+
- The interface for connecting to your [OVHcloud Control Panel](/links/manager) will open.
71+
- Log in with your customer credentials, then click `Authorize`{.action} to use the OVHcloud APIs with your services.
72+
- You will then be automatically redirected to the previous page of the **POST /me/carbonCalculator/task** API.
73+
74+
#### Step 2 - Request the carbon footprint generation and retrieve the requested Task ID
75+
76+
Replace the current date that appears in the API sidebar with the date on which you want to stop calculating the carbon footprint. Please respect the following date format:
77+
78+
```bash
79+
{
80+
"date": "YYYY-MM-DD"
81+
}
82+
```
83+
84+
![API](/pages/assets/screens/api/post-me-carboncalculator-task.png){.thumbnail}
85+
86+
Once you have chosen the correct date, click the blue `EXECUTE`{.action} button.
87+
88+
If everything has been done correctly, a `taskID` will appear in the `RESPONSE`{.action} window when you scroll down the page below the `EXECUTE`{.action} button.
89+
90+
![API](/pages/assets/screens/api/post-me-carboncalculator-task-response.png){.thumbnail}
91+
92+
For example, if your OVHcloud account ID is `aa00000-ovh` and the date you selected earlier is `2025-01-31`, then you will get the following result:
93+
94+
```bash
95+
{
96+
"taskID": "aa00000-ovh_202501"
97+
}
98+
```
99+
100+
Copy only the obtained value which must be equivalent to the value of our example `aa00000-ovh_202501` (without copying the quotation marks (`"`)).
101+
102+
#### Step 3 - Retrieve the carbon footprint report in PDF format
103+
104+
Thanks to the `taskID` value previously retrieved, you can now retrieve the carbon footprint of your services in PDF format.
105+
106+
To do this, stay on our [OVHcloud API](/links/api) website and perform the following actions:
107+
108+
- On the left-hand side of the page, go to the form to the right of the `v1`{.action} field, then select/enter the choice `/me`{.action}.
109+
- From the list of API calls that appear below, locate and click the following API: **GET /me/carbonCalculator/task/{taskID}**. You can also access it directly via the API call below:
110+
111+
> [!api]
112+
>
113+
> @api {v1} /me GET /me/carbonCalculator/task/{taskID}
114+
>
115+
116+
- On the right-hand side of the page, you will then see the API with a form to fill in.
117+
118+
Complete the form in the `PATH PARAMETERS` section as follows:
119+
120+
- `taskID`: Copy here the taskID value retrieved earlier in step 2.
121+
122+
![API](/pages/assets/screens/api/get-me-carboncalculator-task-taskid.png){.thumbnail}
123+
124+
Once you have entered the value for your `taskID` correctly, click the blue `EXECUTE`{.action} button.
125+
126+
The following result appears in the `RESPONSE`{.action} window when you scroll down the page below the `EXECUTE`{.action} button:
127+
128+
![API](/pages/assets/screens/api/get-me-carboncalculator-task-taskid-response.png){.thumbnail}
129+
130+
```bash
131+
{
132+
"link": "Find here the complete URL to download the carbon footprint in PDF format",
133+
"status": "SUCCESS",
134+
"taskID": "aa00000-ovh_202501"
135+
}
136+
```
137+
138+
In this result, copy the entire URL in "HTTPS" (**without the quotation marks**) on the right-hand side of the comment `"link":`, then paste it into the search bar of your web browser to start downloading the carbon footprint in PDF format.
139+
140+
Your web browser will automatically download the file and then display it.
141+
142+
> [!primary]
143+
>
144+
> Depending on your browser’s configuration, the file may not be downloaded and displayed properly. If this is the case, check your browser configuration, then reload the page.
145+
146+
Once you have opened the file, you will find the following items:
147+
148+
- A summary table of C02 emissions by category for the requested month.
149+
- A summary table of C02 emissions by category between the beginning of the calendar year and the requested month.
150+
- A table detailing the values by type of product subscribed.
151+
- A graph showing C02 emissions by category.
152+
153+
> [!warning]
154+
> The link generated is only valid for 24 hours. Make sure to download the carbon footprint from your browser once the link is open.
155+
156+
## Go further <a name="go-further"></a>
157+
158+
[First Steps with the OVHcloud APIs](/pages/manage_and_operate/api/first-steps)
159+
160+
For specialised services (SEO, development, etc.), contact [OVHcloud partners](/links/partner).
161+
162+
Join our [community of users](/links/community).

pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint/guide.en-asia.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please note the following information:
2727

2828
- You cannot generate a carbon footprint report for the current month.
2929
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30-
- No carbon footprint report can be generated for more than the last 24 months.
30+
- No carbon footprint report can be generated for more than the last 24 months.
3131
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
3232

3333
| Service | Date of commissioning of the carbon footprint calculator |

pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint/guide.en-au.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please note the following information:
2727

2828
- You cannot generate a carbon footprint report for the current month.
2929
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30-
- No carbon footprint report can be generated for more than the last 24 months.
30+
- No carbon footprint report can be generated for more than the last 24 months.
3131
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
3232

3333
| Service | Date of commissioning of the carbon footprint calculator |

pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint/guide.en-ca.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please note the following information:
2727

2828
- You cannot generate a carbon footprint report for the current month.
2929
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30-
- No carbon footprint report can be generated for more than the last 24 months.
30+
- No carbon footprint report can be generated for more than the last 24 months.
3131
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
3232

3333
| Service | Date of commissioning of the carbon footprint calculator |

pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint/guide.en-ie.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please note the following information:
2727

2828
- You cannot generate a carbon footprint report for the current month.
2929
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30-
- No carbon footprint report can be generated for more than the last 24 months.
30+
- No carbon footprint report can be generated for more than the last 24 months.
3131
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
3232

3333
| Service | Date of commissioning of the carbon footprint calculator |

pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint/guide.en-sg.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please note the following information:
2727

2828
- You cannot generate a carbon footprint report for the current month.
2929
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30-
- No carbon footprint report can be generated for more than the last 24 months.
30+
- No carbon footprint report can be generated for more than the last 24 months.
3131
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
3232

3333
| Service | Date of commissioning of the carbon footprint calculator |

pages/account_and_service_management/managing_billing_payments_and_services/carbon_footprint/guide.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Please note the following information:
2727

2828
- You cannot generate a carbon footprint report for the current month.
2929
- When using the OVHcloud API, whether you enter a date at the beginning, middle or end of the month for the month chosen, the carbon footprint report will be generated for the full month.
30-
- No carbon footprint report can be generated for more than the last 24 months.
30+
- No carbon footprint report can be generated for more than the last 24 months.
3131
- No carbon footprint can be generated before the date of implementation of the feature for each OVHcloud service (see table below).
3232

3333
| Service | Date of commissioning of the carbon footprint calculator |

0 commit comments

Comments
 (0)