v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB

storage

Get object store bucket details

Retrieves the details of the object store bucket given its name

get/api/v1/orgs/{orgId}/buckets/{name}

Path parameters

orgIdinteger required

Organization identifier

namestring required

Bucket identification

Query parameters

cloudType'amazon' | 'google' | 'azure' required

Identifies the cloud provider

resourceGroupstring

Azure resource group to lookup the bucket(storage container) under. Required only on Azure cloud provider.

storageAccountstring

Azure storage account to lookup the bucket(storage container) under. Required only on Azure cloud provider.

locationstring

The region to lookup the bucket under. Required on Amazon cloud provider.

Headers

secretIdstring

Secret identification

secretNamestring

Secret identification by name

Response

Object store bucket details

namestring required

the name of the object storage / bucket

managedboolean required

true if the bucket has been created via pipeline

cloudstring required

cloud provider of the bucket

locationstring required

location of the bucket

notesstring

notes for the bucket

status'CREATING' | 'AVAILABLE' | 'ERROR_CREATE' | 'DELETING' | 'ERROR_DELETE' required

the status of the bucket

statusMessagestring

the reason for the error status

Example response

{
  "cloud": "amazon",
  "notes": "There's no secret with this ID",
  "managed": true,
  "name": "mybucket",
  "aks": {
    "resourceGroup": "resourceGroup",
    "storageAccount": "storageAccount"
  },
  "location": "eu-west-1",
  "secret": {
    "accessId": "cc051aeaf686444e2f125d0e79eb051aaaf4fb73384f7b0f8c89e84a0502dcef",
    "accessName": "myaccesssecretname",
    "name": "mysecretname",
    "id": "cc051aeaf686444e2f125d0e79eb051aaaf4fb73384f7b0f8c89e84a0502dca1"
  },
  "statusMessage": "statusMessage",
  "status": "CREATING"
}