Skip to main content
GET
/
api
/
deployments
List deployments
curl --request GET \
  --url https://api.example.com/api/deployments \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "provider": "aws_s3",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organisation": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "displayName": "<string>",
      "onboarded": true,
      "themeLogo": "<string>",
      "themePrimaryColor": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "license": "<string>",
      "licenseData": "<unknown>",
      "url": "<string>",
      "preferences": "<unknown>",
      "deletedAt": "<string>"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "configuration": "<unknown>",
    "deletedAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Response

200 - application/json

List of deployments

​
id
string<uuid>
required

Unique identifier of the deployment

​
name
string
required

Name of the deployment

​
provider
enum<string>
required

Cloud storage provider type (aws_s3, azure_storage, google_cloud_storage)

Available options:
aws_s3,
azure_storage,
google_cloud_storage
​
organisationId
string<uuid>
required

ID of the organisation this deployment belongs to

​
organisation
object
required

Organisation associated with the deployment

​
createdAt
string
required

Timestamp when the deployment was created

​
updatedAt
string
required

Timestamp when the deployment was last updated

​
description
string

Description of the deployment

​
configuration
any

Provider-specific configuration settings

​
deletedAt
string

Timestamp when the deployment was deleted