Sign in
storage

List object storage buckets

List object store buckets accessible by the credentials referenced by the given secret. If no credentials provided all managed buckets are returned for all cloud types.

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

Path parameters

orgIdinteger required

Organization identifier

Query parameters

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

Identifies the cloud provider - mandatory if secretId header is provided

include'secret'

Signals whether the secret name is to be returned

Headers

secretIdstring

Secret identification. If not provided only the managed buckets (those created via pipeline) are listed

Response

Storage buckets listed

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"
  }
]

Changes

Changed in 3 of the 50 revisions of this API.211

  • a2e35c4303781See the full diff
    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1d054e88f7571See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5186ea64aa5611See the full diff
    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog