Export FOCUS

All operations require authentication.

5 operationsv2/finops/bucketExport

List FinOps bucket export configurations. The target bucket must be S3™*-compatible.Beta

GET

/v2/finops/bucketExport

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Headers

X-Pagination-Cursor

string

Pagination cursor

X-Pagination-Size

integer

Pagination size

Response

200AsyncConfiguration[]successful operation

checksum

string

Checksum of the Bucket Export Configuration

currentState

read-only

Configuration

Current state of the billing account

currentTasks

read-only

CurrentTask[]

Task to do on this billing account

read-only

string

Unique identifier of the billing account

resourceStatus

read-only

ResourceStatusEnum

Billing account readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

Configuration

Target Spec for the FinOps Bucket Export Configuration

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/finops/bucketExport \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "checksum": "string",4    "currentState": {5      "bucketConfiguration": {6        "accessKey": "string",7        "bucketName": "string",8        "endpointURL": "string",9        "pathPrefix": "string",10        "region": "string",11        "secretKey": "string"12      },13      "exportHour": 0,14      "filePolicy": "CREATE",15      "period": "DAILY",16      "scope": "string"17    },18    "currentTasks": [19      {20        "errors": [21          {22            "message": "string"23          }24        ],25        "id": "00000000-0000-0000-0000-000000000000",26        "link": "string",27        "status": "ERROR",28        "type": "string"29      }30    ],31    "id": "string",32    "resourceStatus": "CREATING",33    "targetSpec": {34      "bucketConfiguration": {35        "accessKey": "string",36        "bucketName": "string",37        "endpointURL": "string",38        "pathPrefix": "string",39        "region": "string",40        "secretKey": "string"41      },42      "exportHour": 0,43      "filePolicy": "CREATE",44      "period": "DAILY",45      "scope": "string"46    }47  }48]

Get a FinOps bucket export configuration. The target bucket must be S3™*-compatible.Beta

GET

/v2/finops/bucketExport/{id}

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Path parameters

required

string

Response

200AsyncConfigurationsuccessful operation

checksum

string

Checksum of the Bucket Export Configuration

currentState

read-only

Configuration

Current state of the billing account

currentTasks

read-only

CurrentTask[]

Task to do on this billing account

read-only

string

Unique identifier of the billing account

resourceStatus

read-only

ResourceStatusEnum

Billing account readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

Configuration

Target Spec for the FinOps Bucket Export Configuration

Example uses id = string

$ curl https://api.eu.ovhcloud.com/v2/finops/bucketExport/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "currentState": {4    "bucketConfiguration": {5      "accessKey": "string",6      "bucketName": "string",7      "endpointURL": "string",8      "pathPrefix": "string",9      "region": "string",10      "secretKey": "string"11    },12    "exportHour": 0,13    "filePolicy": "CREATE",14    "period": "DAILY",15    "scope": "string"16  },17  "currentTasks": [18    {19      "errors": [20        {21          "message": "string"22        }23      ],24      "id": "00000000-0000-0000-0000-000000000000",25      "link": "string",26      "status": "ERROR",27      "type": "string"28    }29  ],30  "id": "string",31  "resourceStatus": "CREATING",32  "targetSpec": {33    "bucketConfiguration": {34      "accessKey": "string",35      "bucketName": "string",36      "endpointURL": "string",37      "pathPrefix": "string",38      "region": "string",39      "secretKey": "string"40    },41    "exportHour": 0,42    "filePolicy": "CREATE",43    "period": "DAILY",44    "scope": "string"45  }46}

Create a FinOps bucket export configuration. The target bucket must be S3™*-compatible.Beta

POST

/v2/finops/bucketExport

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Request body (required)

targetSpec

required

Configuration

Target Spec for the bucket export configuration

Response

200AsyncConfigurationsuccessful operation

checksum

string

Checksum of the Bucket Export Configuration

currentState

read-only

Configuration

Current state of the billing account

currentTasks

read-only

CurrentTask[]

Task to do on this billing account

read-only

string

Unique identifier of the billing account

resourceStatus

read-only

ResourceStatusEnum

Billing account readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

Configuration

Target Spec for the FinOps Bucket Export Configuration

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/finops/bucketExport \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "currentState": {4    "bucketConfiguration": {5      "accessKey": "string",6      "bucketName": "string",7      "endpointURL": "string",8      "pathPrefix": "string",9      "region": "string",10      "secretKey": "string"11    },12    "exportHour": 0,13    "filePolicy": "CREATE",14    "period": "DAILY",15    "scope": "string"16  },17  "currentTasks": [18    {19      "errors": [20        {21          "message": "string"22        }23      ],24      "id": "00000000-0000-0000-0000-000000000000",25      "link": "string",26      "status": "ERROR",27      "type": "string"28    }29  ],30  "id": "string",31  "resourceStatus": "CREATING",32  "targetSpec": {33    "bucketConfiguration": {34      "accessKey": "string",35      "bucketName": "string",36      "endpointURL": "string",37      "pathPrefix": "string",38      "region": "string",39      "secretKey": "string"40    },41    "exportHour": 0,42    "filePolicy": "CREATE",43    "period": "DAILY",44    "scope": "string"45  }46}

Delete a FinOps bucket export configuration. The target bucket must be S3™*-compatible.Beta

DELETE

/v2/finops/bucketExport/{id}

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Path parameters

required

string

Response

200AsyncConfigurationsuccessful operation

checksum

string

Checksum of the Bucket Export Configuration

currentState

read-only

Configuration

Current state of the billing account

currentTasks

read-only

CurrentTask[]

Task to do on this billing account

read-only

string

Unique identifier of the billing account

resourceStatus

read-only

ResourceStatusEnum

Billing account readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

Configuration

Target Spec for the FinOps Bucket Export Configuration

Example uses id = string

$ curl https://api.eu.ovhcloud.com/v2/finops/bucketExport/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "currentState": {4    "bucketConfiguration": {5      "accessKey": "string",6      "bucketName": "string",7      "endpointURL": "string",8      "pathPrefix": "string",9      "region": "string",10      "secretKey": "string"11    },12    "exportHour": 0,13    "filePolicy": "CREATE",14    "period": "DAILY",15    "scope": "string"16  },17  "currentTasks": [18    {19      "errors": [20        {21          "message": "string"22        }23      ],24      "id": "00000000-0000-0000-0000-000000000000",25      "link": "string",26      "status": "ERROR",27      "type": "string"28    }29  ],30  "id": "string",31  "resourceStatus": "CREATING",32  "targetSpec": {33    "bucketConfiguration": {34      "accessKey": "string",35      "bucketName": "string",36      "endpointURL": "string",37      "pathPrefix": "string",38      "region": "string",39      "secretKey": "string"40    },41    "exportHour": 0,42    "filePolicy": "CREATE",43    "period": "DAILY",44    "scope": "string"45  }46}

Modify a FinOps bucket export configuration. The target bucket must be S3™*-compatible.Beta

PUT

/v2/finops/bucketExport/{id}

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

Path parameters

required

string

Request body (required)

checksum

string

Checksum of the Bucket Export Configuration

currentState

read-only

Configuration

Current state of the billing account

currentTasks

read-only

CurrentTask[]

Task to do on this billing account

read-only

string

Unique identifier of the billing account

resourceStatus

read-only

ResourceStatusEnum

Billing account readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

Configuration

Target Spec for the FinOps Bucket Export Configuration

Response

200AsyncConfigurationsuccessful operation

checksum

string

Checksum of the Bucket Export Configuration

currentState

read-only

Configuration

Current state of the billing account

currentTasks

read-only

CurrentTask[]

Task to do on this billing account

read-only

string

Unique identifier of the billing account

resourceStatus

read-only

ResourceStatusEnum

Billing account readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING

targetSpec

Configuration

Target Spec for the FinOps Bucket Export Configuration

Example uses id = string

$ curl https://api.eu.ovhcloud.com/v2/finops/bucketExport/{id} \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "checksum": "string",3  "currentState": {4    "bucketConfiguration": {5      "accessKey": "string",6      "bucketName": "string",7      "endpointURL": "string",8      "pathPrefix": "string",9      "region": "string",10      "secretKey": "string"11    },12    "exportHour": 0,13    "filePolicy": "CREATE",14    "period": "DAILY",15    "scope": "string"16  },17  "currentTasks": [18    {19      "errors": [20        {21          "message": "string"22        }23      ],24      "id": "00000000-0000-0000-0000-000000000000",25      "link": "string",26      "status": "ERROR",27      "type": "string"28    }29  ],30  "id": "string",31  "resourceStatus": "CREATING",32  "targetSpec": {33    "bucketConfiguration": {34      "accessKey": "string",35      "bucketName": "string",36      "endpointURL": "string",37      "pathPrefix": "string",38      "region": "string",39      "secretKey": "string"40    },41    "exportHour": 0,42    "filePolicy": "CREATE",43    "period": "DAILY",44    "scope": "string"45  }46}