API

Registries

Registries are 3rd party registries where the images of versions are located. Learn more about registries here.

Fetch data of registries.

Lists every registries available in the active team. Request must include teamSlug in URL. Response is an array including the name, id, type, description, and icon of the registry.</br></br>Registries are 3rd party registries where the container images are stored.

get

/api/{teamSlug}/registries

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/registries'

200

403

200

[
  {
    "type": "v2",
    "id": "text",
    "name": "text",
    "description": "text",
    "icon": "text",
    "url": "text"
  }
]

Data of all registries within a team listed.

Create a new registry.

To add a new registry, include teamSlug in URL, body must include name, type, description, details, and icon. Type, details, and name are required. Response is an array including the name, id, type, description, imageNamePrefix, inUse, icon, and audit log info of the registry.

post

/api/{teamSlug}/registries

Path parameters

teamSlugstringrequired

Body

typestring · enumrequired

Options: group, project

detailsone ofrequired

namestringrequired

descriptionstring | nullable

iconstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/registries' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "group",
    "details": {
      "imageNamePrefix": "text"
    },
    "name": "text",
    "description": "text",
    "icon": "text"
  }'

201

400

403

409

201

{
  "type": "group",
  "details": {
    "imageNamePrefix": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "icon": "text",
  "inUse": true,
  "createdAt": "2025-03-09T15:03:42.338Z",
  "updatedAt": "2025-03-09T15:03:42.338Z"
}

New registry created.

Fetch data of a registry.

Lists the details of a registry. Request must include teamSlug and RegistryID in URL. registryId refers to the registry's ID. Response is an array including the name, id, type, description, imageNamePrefix, inUse, icon, and audit log info of the registry.

get

/api/{teamSlug}/registries/{registryId}

Path parameters

teamSlugstringrequired

registryIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/registries/{registryId}'

200

400

403

404

200

{
  "type": "group",
  "details": {
    "imageNamePrefix": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "icon": "text",
  "inUse": true,
  "createdAt": "2025-03-09T15:03:42.338Z",
  "updatedAt": "2025-03-09T15:03:42.338Z"
}

Data of a registry listed.

Modify the details of a registry.

Modify the name, type, description, details, and icon. RegistryId refers to the registry's ID. teamSlug and RegistryID is required in URL, body must include type, details, and name.

put

/api/{teamSlug}/registries/{registryId}

Path parameters

teamSlugstringrequired

registryIdstringrequired

Body

typestring · enumrequired

Options: group, project

detailsone ofrequired

namestringrequired

descriptionstring | nullable

iconstring | nullable

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/registries/{registryId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "group",
    "details": {
      "imageNamePrefix": "text"
    },
    "name": "text",
    "description": "text",
    "icon": "text"
  }'

204

400

403

404

409

204

No body

Registry modified.

Delete a registry from dyrector.io.

Deletes a registry with the specified registryId. teamSlug and RegistryID are required in URL.

delete

/api/{teamSlug}/registries/{registryId}

Path parameters

teamSlugstringrequired

registryIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/registries/{registryId}'

204

403

404

204

No body

Registry deleted.

Projects

There are two kinds of projects in dyrector.io: versionless and versioned. Versionless projects make up one deployable unit without versioning, while versioned projects come with multiple rolling or incremental versions. More details here.

Fetch the projects list.

Returns a list of a team's projects and their details. teamSlug needs to be included in URL.

get

/api/{teamSlug}/projects

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/projects'

200

403

200

[
  {
    "type": "versionless",
    "description": "text",
    "versionCount": 1,
    "audit": {
      "createdAt": "2025-03-09T15:03:42.338Z",
      "createdBy": "text",
      "updatedAt": "2025-03-09T15:03:42.338Z",
      "updatedBy": "text"
    },
    "id": "text",
    "name": "text"
  }
]

List of projects.

Create a new project for a team.

Create a new project for a team. teamSlug needs to be included in URL. Newly created team has a type and a name as required variables, and optionally a description and a changelog.

post

/api/{teamSlug}/projects

Path parameters

teamSlugstringrequired

Body

typestring · enumrequired

Options: versionless, versioned

namestringrequired

descriptionstring | nullable

changelogstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/projects' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "versionless",
    "name": "text",
    "description": "text",
    "changelog": "text"
  }'

201

400

403

409

201

{
  "type": "versionless",
  "description": "text",
  "versionCount": 1,
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "id": "text",
  "name": "text"
}

New project created.

Fetch details of a project.

Returns a project's details. teamSlug and ProjectID needs to be included in URL. The response should contain an array, consisting of the project's name, id, type, description, deletability, versions and version related data, including version name and id, changelog, increasibility.

get

/api/{teamSlug}/projects/{projectId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/projects/{projectId}'

200

400

403

404

200

{
  "type": "versionless",
  "description": "text",
  "deletable": true,
  "versions": [
    {
      "type": "incremental",
      "audit": {
        "createdAt": "2025-03-09T15:03:42.338Z",
        "createdBy": "text",
        "updatedAt": "2025-03-09T15:03:42.338Z",
        "updatedBy": "text"
      },
      "changelog": "text",
      "default": true,
      "increasable": true,
      "id": "text",
      "name": "text"
    }
  ],
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "id": "text",
  "name": "text"
}

Details of a project.

Update a project.

Updates a project. teamSlug is required in URL, as well as projectId to identify which project is modified, name, description and changelog can be adjusted with this call.

put

/api/{teamSlug}/projects/{projectId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

Body

namestringrequired

descriptionstring | nullable

changelogstring | nullable

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/projects/{projectId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "changelog": "text"
  }'

204

400

403

404

409

204

No body

Project details are modified.

Delete a project.

Deletes a project with the specified projectId. teamSlug and ProjectID are required in URL.

delete

/api/{teamSlug}/projects/{projectId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/projects/{projectId}'

204

403

404

204

No body

Project deleted.

Convert a project to versioned.

Converts a project to versioned with the specified projectId. teamSlug and ProjectID are required in URL.

post

/api/{teamSlug}/projects/{projectId}/convert

Path parameters

teamSlugstringrequired

projectIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/projects/{projectId}/convert'

204

400

403

204

No body

Project converted.

Versions

Versions belong to versioned projects. Versionless projects act similar to a rolling version of a versioned project.

The purpose of versions is to separate different variations of your project. They can be either rolling or incremental. One versionless project can have multiple versions of both types. More details about rolling and incremental versions here.

Fetch the list of all the versions under a project.

Returns an array containing the every version that belong to a project. teamSlug and ProjectId must be included in URL. ProjectId refers to the project's ID. Details include the version's name, id, type, audit log details, changelog, and increasibility.

get

/api/{teamSlug}/projects/{projectId}/versions

Path parameters

teamSlugstringrequired

projectIdstringrequired

Query parameters

nameContainsstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/projects/{projectId}/versions'

200

403

200

[
  {
    "type": "incremental",
    "audit": {
      "createdAt": "2025-03-09T15:03:42.338Z",
      "createdBy": "text",
      "updatedAt": "2025-03-09T15:03:42.338Z",
      "updatedBy": "text"
    },
    "changelog": "text",
    "default": true,
    "increasable": true,
    "id": "text",
    "name": "text"
  }
]

Returns an array with every versions of a project.

Create a new version.

Creates a new version in a project. projectId refers to the project's ID. teamSlug and ProjectId must be included in URL, request's body need to include name and type of the version, changelog is optionable. Response should include the name, id, changelog, increasibility, type, and audit log details of the version.

post

/api/{teamSlug}/projects/{projectId}/versions

Path parameters

teamSlugstringrequired

projectIdstringrequired

Body

typestring · enumrequired

Options: incremental, rolling

namestringrequired

changelogstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/projects/{projectId}/versions' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "incremental",
    "name": "text",
    "changelog": "text"
  }'

201

400

403

409

201

{
  "type": "incremental",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "changelog": "text",
  "default": true,
  "increasable": true,
  "id": "text",
  "name": "text"
}

New version created.

Retrieve the details of a version of a project.

Returns the details of a version in the project. teamSlug and ProjectId must be included in URL. projectId refers to the project's ID, versionId refers to the version's ID. Details include the version's name, id, type, audit log details, changelog, increasibility, mutability, deletability, and all image related data, including name, id, tag, order and configuration data of the images.

get

/api/{teamSlug}/projects/{projectId}/versions/{versionId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}'

200

400

403

404

200

{
  "type": "incremental",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "changelog": "text",
  "default": true,
  "increasable": true,
  "id": "text",
  "name": "text",
  "mutable": true,
  "deletable": true,
  "images": [
    {
      "id": "text",
      "name": "text",
      "tag": "text",
      "order": 1,
      "config": {
        "expose": "none",
        "restartPolicy": "always",
        "networkMode": "none",
        "deploymentStrategy": "recreate",
        "name": "text",
        "environment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "secrets": [
          {
            "required": true,
            "id": "text",
            "key": "text"
          }
        ],
        "routing": {
          "domain": "text",
          "path": "text",
          "stripPath": true,
          "uploadLimit": "text"
        },
        "user": 1,
        "tty": true,
        "configContainer": {
          "image": "text",
          "volume": "text",
          "path": "text",
          "keepFiles": true
        },
        "ports": [
          {
            "id": "text",
            "internal": 1,
            "external": 1
          }
        ],
        "portRanges": [
          {
            "id": "text",
            "internal": {
              "from": 1,
              "to": 1
            },
            "external": {
              "from": 1,
              "to": 1
            }
          }
        ],
        "volumes": [
          {
            "type": "ro",
            "id": "text",
            "name": "text",
            "path": "text",
            "size": "text",
            "class": "text"
          }
        ],
        "commands": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "args": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "initContainers": [
          {
            "id": "text",
            "name": "text",
            "image": "text",
            "command": [
              {
                "id": "text",
                "key": "text"
              }
            ],
            "args": [
              {
                "id": "text",
                "key": "text"
              }
            ],
            "environment": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ],
            "useParentConfig": true,
            "volumes": [
              {
                "id": "text",
                "name": "text",
                "path": "text"
              }
            ]
          }
        ],
        "capabilities": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "storage": {
          "storageId": "text",
          "path": "text",
          "bucket": "text"
        },
        "logConfig": {
          "driver": "nodeDefault",
          "options": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ]
        },
        "networks": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "dockerLabels": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "customHeaders": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "proxyHeaders": true,
        "useLoadBalancer": true,
        "extraLBAnnotations": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "healthCheckConfig": {
          "port": 1,
          "livenessProbe": "text",
          "readinessProbe": "text",
          "startupProbe": "text"
        },
        "resourceConfig": {
          "limits": {
            "cpu": "text",
            "memory": "text"
          },
          "requests": {
            "cpu": "text",
            "memory": "text"
          }
        },
        "annotations": {
          "service": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "deployment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "ingress": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ]
        },
        "labels": {
          "service": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "deployment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "ingress": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ]
        }
      },
      "createdAt": "2025-03-09T15:03:42.338Z",
      "registry": {
        "type": "v2",
        "id": "text",
        "name": "text"
      }
    }
  ],
  "deployments": [
    {
      "status": "preparing",
      "note": "text",
      "updatedAt": "2025-03-09T15:03:42.338Z",
      "node": {
        "type": "docker",
        "status": "unreachable",
        "id": "text",
        "name": "text"
      },
      "id": "text",
      "prefix": "text"
    }
  ]
}

Details of a version under a project is fetched.

Modify version.

Updates a version's name and changelog. teamSlug, ProjectId and VersionId must be included in URL. projectId refers to the project's ID, versionId refers to the version's ID.

put

/api/{teamSlug}/projects/{projectId}/versions/{versionId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Body

namestringrequired

changelogstring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "changelog": "text"
  }'

204

400

403

404

409

204

No body

Changelog of a version is updated.

Delete a version.

This call deletes a version. teamSlug, ProjectId and VersionId must be included in URL. projectId refers to the project's ID, versionId refers to the version's ID.

delete

/api/{teamSlug}/projects/{projectId}/versions/{versionId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}'

204

403

404

204

No body

Version deleted.

Turn version into a default one of the versioned project other versions under it will inherit images and deployments from.

This call turns a version into the default one, resulting other versions within this project later inherit images, deployments and their configurations from it. teamSlug, ProjectId and VersionId must be included in URL. projectId refers to the project's ID, versionId refers to the version's ID.

put

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/default

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/default'

204

400

403

404

204

No body

Version turned into default.

Increase a the version of a versioned project with a new version.

Increases the version of a project with a new child version. teamSlug, ProjectId and VersionId must be included in URL. projectId refers to the project's ID, versionId refers to the version's ID. name refers to the name of the new version, and is required in the body.

post

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/increase

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Body

namestringrequired

changelogstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/increase' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "changelog": "text"
  }'

201

400

403

201

{
  "type": "incremental",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "changelog": "text",
  "default": true,
  "increasable": true,
  "id": "text",
  "name": "text"
}

New version created.

Version/Images

Images make up a versioned project's version, or a versionless project.

Fetch data of all images of a version.

Fetch details of images within a version. ProjectId refers to the project's ID, versionId refers to the version's ID. Both, and teamSlug are required in the URL.</br></br>Details come in an array, including name, id, tag, order, and config details of the image.

get

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images'

200

403

200

[
  {
    "id": "text",
    "name": "text",
    "tag": "text",
    "order": 1,
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": true,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": true,
        "uploadLimit": "text"
      },
      "user": 1,
      "tty": true,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": true
      },
      "ports": [
        {
          "id": "text",
          "internal": 1,
          "external": 1
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 1,
            "to": 1
          },
          "external": {
            "from": 1,
            "to": 1
          }
        }
      ],
      "volumes": [
        {
          "type": "ro",
          "id": "text",
          "name": "text",
          "path": "text",
          "size": "text",
          "class": "text"
        }
      ],
      "commands": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "args": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "initContainers": [
        {
          "id": "text",
          "name": "text",
          "image": "text",
          "command": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "args": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "useParentConfig": true,
          "volumes": [
            {
              "id": "text",
              "name": "text",
              "path": "text"
            }
          ]
        }
      ],
      "capabilities": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "storage": {
        "storageId": "text",
        "path": "text",
        "bucket": "text"
      },
      "logConfig": {
        "driver": "nodeDefault",
        "options": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "networks": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "dockerLabels": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "customHeaders": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "proxyHeaders": true,
      "useLoadBalancer": true,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 1,
        "livenessProbe": "text",
        "readinessProbe": "text",
        "startupProbe": "text"
      },
      "resourceConfig": {
        "limits": {
          "cpu": "text",
          "memory": "text"
        },
        "requests": {
          "cpu": "text",
          "memory": "text"
        }
      },
      "annotations": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "labels": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      }
    },
    "createdAt": "2025-03-09T15:03:42.338Z",
    "registry": {
      "type": "v2",
      "id": "text",
      "name": "text"
    }
  }
]

Data of images listed.

Add images to a version.

Add new images to a version. projectId refers to the project's ID, versionId refers to the version's ID. These, and teamSlug are required in the URL. registryId refers to the registry's ID, images refers to the name(s) of the images you'd like to add. These are required variables in the body.

post

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Body

registryIdstringrequired

imagesstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "registryId": "text",
      "images": [
        "text"
      ]
    }
  ]'

201

400

403

201

[
  {
    "id": "text",
    "name": "text",
    "tag": "text",
    "order": 1,
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": true,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": true,
        "uploadLimit": "text"
      },
      "user": 1,
      "tty": true,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": true
      },
      "ports": [
        {
          "id": "text",
          "internal": 1,
          "external": 1
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 1,
            "to": 1
          },
          "external": {
            "from": 1,
            "to": 1
          }
        }
      ],
      "volumes": [
        {
          "type": "ro",
          "id": "text",
          "name": "text",
          "path": "text",
          "size": "text",
          "class": "text"
        }
      ],
      "commands": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "args": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "initContainers": [
        {
          "id": "text",
          "name": "text",
          "image": "text",
          "command": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "args": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "useParentConfig": true,
          "volumes": [
            {
              "id": "text",
              "name": "text",
              "path": "text"
            }
          ]
        }
      ],
      "capabilities": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "storage": {
        "storageId": "text",
        "path": "text",
        "bucket": "text"
      },
      "logConfig": {
        "driver": "nodeDefault",
        "options": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "networks": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "dockerLabels": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "customHeaders": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "proxyHeaders": true,
      "useLoadBalancer": true,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 1,
        "livenessProbe": "text",
        "readinessProbe": "text",
        "startupProbe": "text"
      },
      "resourceConfig": {
        "limits": {
          "cpu": "text",
          "memory": "text"
        },
        "requests": {
          "cpu": "text",
          "memory": "text"
        }
      },
      "annotations": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "labels": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      }
    },
    "createdAt": "2025-03-09T15:03:42.338Z",
    "registry": {
      "type": "v2",
      "id": "text",
      "name": "text"
    }
  }
]

New image added.

Fetch data of an image of a version.

Fetch details of an image within a version. projectId refers to the project's ID, versionId refers to the version's ID, imageId refers to the image's ID. All, and teamSlug are required in the URL.</br></br>Image details consists name, id, tag, order, and the config of the image.

get

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

imageIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}'

200

400

403

404

200

{
  "id": "text",
  "name": "text",
  "tag": "text",
  "order": 1,
  "config": {
    "expose": "none",
    "restartPolicy": "always",
    "networkMode": "none",
    "deploymentStrategy": "recreate",
    "name": "text",
    "environment": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "secrets": [
      {
        "required": true,
        "id": "text",
        "key": "text"
      }
    ],
    "routing": {
      "domain": "text",
      "path": "text",
      "stripPath": true,
      "uploadLimit": "text"
    },
    "user": 1,
    "tty": true,
    "configContainer": {
      "image": "text",
      "volume": "text",
      "path": "text",
      "keepFiles": true
    },
    "ports": [
      {
        "id": "text",
        "internal": 1,
        "external": 1
      }
    ],
    "portRanges": [
      {
        "id": "text",
        "internal": {
          "from": 1,
          "to": 1
        },
        "external": {
          "from": 1,
          "to": 1
        }
      }
    ],
    "volumes": [
      {
        "type": "ro",
        "id": "text",
        "name": "text",
        "path": "text",
        "size": "text",
        "class": "text"
      }
    ],
    "commands": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "args": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "initContainers": [
      {
        "id": "text",
        "name": "text",
        "image": "text",
        "command": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "args": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "environment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "useParentConfig": true,
        "volumes": [
          {
            "id": "text",
            "name": "text",
            "path": "text"
          }
        ]
      }
    ],
    "capabilities": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "storage": {
      "storageId": "text",
      "path": "text",
      "bucket": "text"
    },
    "logConfig": {
      "driver": "nodeDefault",
      "options": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ]
    },
    "networks": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "dockerLabels": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "customHeaders": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "proxyHeaders": true,
    "useLoadBalancer": true,
    "extraLBAnnotations": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "healthCheckConfig": {
      "port": 1,
      "livenessProbe": "text",
      "readinessProbe": "text",
      "startupProbe": "text"
    },
    "resourceConfig": {
      "limits": {
        "cpu": "text",
        "memory": "text"
      },
      "requests": {
        "cpu": "text",
        "memory": "text"
      }
    },
    "annotations": {
      "service": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "deployment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "ingress": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ]
    },
    "labels": {
      "service": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "deployment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "ingress": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ]
    }
  },
  "createdAt": "2025-03-09T15:03:42.338Z",
  "registry": {
    "type": "v2",
    "id": "text",
    "name": "text"
  }
}

Data of an image.

Delete an image from a version.

Delete an image. projectId refers to the project's ID, versionId refers to the version's ID, imageId refers to the image's ID. All, and teamSlug are required in the URL.

delete

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

imageIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}'

204

403

404

204

No body

Delete an image from a version.

Configure an image of a version.

Modify the configuration variables of an image. projectId refers to the project's ID, versionId refers to the version's ID, imageId refers to the image's ID. All, and teamSlug are required in the URL. Tag refers to the version of the image, config is an object of configuration variables.

patch

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

imageIdstringrequired

Body

tagstring | nullable

configall of | nullable

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "tag": "text",
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": true,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": true,
        "uploadLimit": "text"
      },
      "user": 1,
      "tty": true,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": true
      },
      "ports": [
        {
          "id": "text",
          "internal": 1,
          "external": 1
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 1,
            "to": 1
          },
          "external": {
            "from": 1,
            "to": 1
          }
        }
      ],
      "volumes": [
        {
          "type": "ro",
          "id": "text",
          "name": "text",
          "path": "text",
          "size": "text",
          "class": "text"
        }
      ],
      "commands": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "args": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "initContainers": [
        {
          "id": "text",
          "name": "text",
          "image": "text",
          "command": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "args": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "useParentConfig": true,
          "volumes": [
            {
              "id": "text",
              "name": "text",
              "path": "text"
            }
          ]
        }
      ],
      "capabilities": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "storage": {
        "storageId": "text",
        "path": "text",
        "bucket": "text"
      },
      "logConfig": {
        "driver": "nodeDefault",
        "options": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "networks": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "dockerLabels": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "customHeaders": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "proxyHeaders": true,
      "useLoadBalancer": true,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 1,
        "livenessProbe": "text",
        "readinessProbe": "text",
        "startupProbe": "text"
      },
      "resourceConfig": {
        "limits": {
          "cpu": "text",
          "memory": "text"
        },
        "requests": {
          "cpu": "text",
          "memory": "text"
        }
      },
      "annotations": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "labels": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      }
    }
  }'

204

400

403

404

204

No body

Image's configure variables updated.

Edit image deployment order of a version.

Edit image deployment order of a version. projectId refers to the project's ID, versionId refers to the version's ID. Both, and teamSlug are required in the URL. Request body should include the IDs of the images in an array.

put

/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/order

Path parameters

teamSlugstringrequired

projectIdstringrequired

versionIdstringrequired

Body

string[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/order' \
  --header 'Content-Type: application/json' \
  --data '[
    "text"
  ]'

204

400

403

204

No body

Image order modified.

Teams

Teams are the shared entity of multiple users. The purpose of teams is to separate users, nodes and projects based on their needs within an organization. Team owners can assign roles. More details about teams here.

Fetch data of teams the user is a member of.

List of teams consist of name, id, and statistics, including number of users, projects, nodes, versions, and deployments.</br></br>Teams are the shared entity of multiple users. The purpose of teams is to separate users, nodes and projects based on their needs within an organization. Team owners can assign roles. More details about teams here.

get

/api/teams

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/teams'

200

403

200

[
  {
    "statistics": {
      "users": 1,
      "projects": 1,
      "nodes": 1,
      "versions": 1,
      "deployments": 1
    },
    "id": "text",
    "name": "text",
    "slug": "text"
  }
]

List of teams and their statistics.

Create new team.

Request must include name, which is going to be the name of the newly made team. Response should include name, id, and statistics, including number of users, projects, nodes, versions, and deployments.

post

/api/teams

Body

slugstringrequired

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/teams' \
  --header 'Content-Type: application/json' \
  --data '{
    "slug": "text",
    "name": "text"
  }'

201

400

403

409

201

{
  "statistics": {
    "users": 1,
    "projects": 1,
    "nodes": 1,
    "versions": 1,
    "deployments": 1
  },
  "id": "text",
  "name": "text",
  "slug": "text"
}

New team created.

Fetch data of a team the user is a member of.

Get the details of a team. Request must include teamId, which is the ID of the team they'd like to get the data of. Data of teams consist of name, id, and statistics, including number of users, projects, nodes, versions, and deployments. Response should include user details, as well, including name, id, role, status, email, and lastLogin.

get

/api/teams/{teamId}

Path parameters

teamIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/teams/{teamId}'

200

400

403

404

200

{
  "statistics": {
    "users": 1,
    "projects": 1,
    "nodes": 1,
    "versions": 1,
    "deployments": 1
  },
  "id": "text",
  "name": "text",
  "slug": "text",
  "users": [
    {
      "role": "owner",
      "status": "pending",
      "email": "text",
      "lastLogin": "2025-03-09T15:03:42.338Z",
      "id": "text",
      "name": "text"
    }
  ]
}

Details of the team.

Modify a team's name.

Request must include teamId and name. Admin access required for a successful request.

put

/api/teams/{teamId}

Path parameters

teamIdstringrequired

Body

slugstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/teams/{teamId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "slug": "text",
    "name": "text"
  }'

204

400

403

404

409

204

No body

Team name modified.

Deletes a team.

Request must include teamId. Owner access required for successful request.

delete

/api/teams/{teamId}

Path parameters

teamIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/teams/{teamId}'

204

403

404

204

No body

Team deleted.

Invite a new user to the team.

Request must include teamId, email and firstName. Admin access required for a successful request.</br></br>Response should include new user's name, id, role, status, email, and lastLogin. Admin access required for a successful request.

post

/api/teams/{teamId}/users

Path parameters

teamIdstringrequired

Body

emailstringrequired

firstNamestringrequired

lastNamestring

captchastring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/teams/{teamId}/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "text",
    "firstName": "text",
    "lastName": "text",
    "captcha": "text"
  }'

201

400

403

409

201

{
  "role": "owner",
  "status": "pending",
  "email": "text",
  "lastLogin": "2025-03-09T15:03:42.338Z",
  "id": "text",
  "name": "text"
}

User invited.

Edit user role.

Promotes or demotes the user. Request must include teamId, userId and role. Admin access required for a successful request.

put

/api/teams/{teamId}/users/{userId}/role

Path parameters

teamIdstringrequired

userIdstringrequired

Body

rolestring · enumrequired

Options: owner, admin, user

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/teams/{teamId}/users/{userId}/role' \
  --header 'Content-Type: application/json' \
  --data '{
    "role": "owner"
  }'

204

400

403

404

204

No body

User's role modified.

Remove the current user from the team.

Removes the current user from the team. Request must include teamId.

delete

/api/teams/{teamId}/users/leave

Path parameters

teamIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/teams/{teamId}/users/leave'

204

403

404

204

No body

User removed from a team.

Remove a user from the team.

Removes the user from the team. Request must include teamId, userId. Admin access required for a successful request.

delete

/api/teams/{teamId}/users/{userId}

Path parameters

teamIdstringrequired

userIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/teams/{teamId}/users/{userId}'

204

403

404

204

No body

User removed from a team.

Reinvite user with a pending invite status to a team.

This call sends a new invitation link to a user who hasn't accepted invitation to a team.</br></br>Request must include teamId, userId. Admin access required for a successful request.

post

/api/teams/{teamId}/users/{userId}/reinvite

Path parameters

teamIdstringrequired

userIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/teams/{teamId}/users/{userId}/reinvite'

204

400

403

204

No body

New invite link sent.

Users/Me

Users/Me cover endpoints related to your user profile.

Fetch the current user.

Response includes the user, teams, and invitations.

post

/api/users/me

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/users/me'

200

400

403

200

{
  "user": {
    "id": "text",
    "name": "text"
  },
  "teams": [
    {
      "role": "owner",
      "id": "text",
      "name": "text",
      "slug": "text"
    }
  ],
  "invitations": [
    {
      "id": "text",
      "name": "text",
      "slug": "text"
    }
  ]
}

Fetch the current user.

Accept invitation to a team.

Request must include teamId.

post

/api/users/me/invitations/{teamId}

Path parameters

teamIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/users/me/invitations/{teamId}'

204

400

403

204

No body

Invitation accepted.

Decline invitation to a team.

Request must include teamId.

delete

/api/users/me/invitations/{teamId}

Path parameters

teamIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/users/me/invitations/{teamId}'

204

403

404

204

No body

Invitation declined.

Sets the onboarding tips to visible for the user.

Enable onboarding tips.

put

/api/users/me/preferences/onboarding

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/users/me/preferences/onboarding'

204

403

204

No body

Enabled.

Sets the onboarding tips to hidden for the user.

Disable onboarding tips.

delete

/api/users/me/preferences/onboarding

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/users/me/preferences/onboarding'

204

403

204

No body

Disabled.

Deployments

Deployments are the process that gets the installation of your versions or versionless projects done on the node of your choice. More details about deployments here.

Fetch the list of deployments.

Get the list of deployments. Request needs to include teamSlug in URL. A deployment should include id, prefix, status, note, audit log details, project name, id, type, version name, type, id, and node name, id, type.

get

/api/{teamSlug}/deployments

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/deployments'

200

403

200

[
  {
    "status": "preparing",
    "note": "text",
    "audit": {
      "createdAt": "2025-03-09T15:03:42.338Z",
      "createdBy": "text",
      "updatedAt": "2025-03-09T15:03:42.338Z",
      "updatedBy": "text"
    },
    "project": {
      "type": "versionless",
      "id": "text",
      "name": "text"
    },
    "version": {
      "type": "incremental",
      "id": "text",
      "name": "text"
    },
    "node": {
      "type": "docker",
      "id": "text",
      "name": "text"
    },
    "id": "text",
    "prefix": "text"
  }
]

List of deployments.

Create new deployment.

Request must include teamSlug in URL, versionId, nodeId, and prefix, which refers to the ID of a version, a node and the prefix of the deployment, must be included in body. Response should include deployment id, prefix, status, note, and audit log details, as well as project type, id, name, version type, id, name, and node type, id, name.

post

/api/{teamSlug}/deployments

Path parameters

teamSlugstringrequired

Body

versionIdstringrequired

nodeIdstringrequired

prefixstringrequired

notestring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/deployments' \
  --header 'Content-Type: application/json' \
  --data '{
    "versionId": "text",
    "nodeId": "text",
    "prefix": "text",
    "note": "text"
  }'

201

400

403

409

201

{
  "status": "preparing",
  "note": "text",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "project": {
    "type": "versionless",
    "id": "text",
    "name": "text"
  },
  "version": {
    "type": "incremental",
    "id": "text",
    "name": "text"
  },
  "node": {
    "type": "docker",
    "id": "text",
    "name": "text"
  },
  "id": "text",
  "prefix": "text"
}

New deployment created.

Retrieve details of a deployment.

Get details of a certain deployment. Request must include teamSlug and deploymentId in URL. Deployment details should include id, prefix, environment, status, note, audit log details, project name, id, type, version name, type, id, and node name, id, type.

get

/api/{teamSlug}/deployments/{deploymentId}

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/deployments/{deploymentId}'

200

400

403

404

200

{
  "status": "preparing",
  "note": "text",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "project": {
    "type": "versionless",
    "id": "text",
    "name": "text"
  },
  "version": {
    "type": "incremental",
    "id": "text",
    "name": "text"
  },
  "node": {
    "type": "docker",
    "id": "text",
    "name": "text"
  },
  "id": "text",
  "prefix": "text",
  "environment": [
    {
      "value": "text",
      "id": "text",
      "key": "text"
    }
  ],
  "publicKey": "text",
  "instances": [
    {
      "id": "text",
      "updatedAt": "2025-03-09T15:03:42.338Z",
      "image": {
        "id": "text",
        "name": "text",
        "tag": "text",
        "order": 1,
        "config": {
          "expose": "none",
          "restartPolicy": "always",
          "networkMode": "none",
          "deploymentStrategy": "recreate",
          "name": "text",
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "secrets": [
            {
              "required": true,
              "id": "text",
              "key": "text"
            }
          ],
          "routing": {
            "domain": "text",
            "path": "text",
            "stripPath": true,
            "uploadLimit": "text"
          },
          "user": 1,
          "tty": true,
          "configContainer": {
            "image": "text",
            "volume": "text",
            "path": "text",
            "keepFiles": true
          },
          "ports": [
            {
              "id": "text",
              "internal": 1,
              "external": 1
            }
          ],
          "portRanges": [
            {
              "id": "text",
              "internal": {
                "from": 1,
                "to": 1
              },
              "external": {
                "from": 1,
                "to": 1
              }
            }
          ],
          "volumes": [
            {
              "type": "ro",
              "id": "text",
              "name": "text",
              "path": "text",
              "size": "text",
              "class": "text"
            }
          ],
          "commands": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "args": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "initContainers": [
            {
              "id": "text",
              "name": "text",
              "image": "text",
              "command": [
                {
                  "id": "text",
                  "key": "text"
                }
              ],
              "args": [
                {
                  "id": "text",
                  "key": "text"
                }
              ],
              "environment": [
                {
                  "value": "text",
                  "id": "text",
                  "key": "text"
                }
              ],
              "useParentConfig": true,
              "volumes": [
                {
                  "id": "text",
                  "name": "text",
                  "path": "text"
                }
              ]
            }
          ],
          "capabilities": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "storage": {
            "storageId": "text",
            "path": "text",
            "bucket": "text"
          },
          "logConfig": {
            "driver": "nodeDefault",
            "options": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ]
          },
          "networks": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "dockerLabels": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "customHeaders": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "proxyHeaders": true,
          "useLoadBalancer": true,
          "extraLBAnnotations": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "healthCheckConfig": {
            "port": 1,
            "livenessProbe": "text",
            "readinessProbe": "text",
            "startupProbe": "text"
          },
          "resourceConfig": {
            "limits": {
              "cpu": "text",
              "memory": "text"
            },
            "requests": {
              "cpu": "text",
              "memory": "text"
            }
          },
          "annotations": {
            "service": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ],
            "deployment": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ],
            "ingress": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ]
          },
          "labels": {
            "service": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ],
            "deployment": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ],
            "ingress": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ]
          }
        },
        "createdAt": "2025-03-09T15:03:42.338Z",
        "registry": {
          "type": "v2",
          "id": "text",
          "name": "text"
        }
      },
      "config": {
        "expose": "none",
        "restartPolicy": "always",
        "networkMode": "none",
        "deploymentStrategy": "recreate",
        "secrets": [
          {
            "required": true,
            "id": "text",
            "key": "text",
            "value": "text",
            "encrypted": true,
            "publicKey": "text"
          }
        ],
        "name": "text",
        "environment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "routing": {
          "domain": "text",
          "path": "text",
          "stripPath": true,
          "uploadLimit": "text"
        },
        "user": 1,
        "tty": true,
        "configContainer": {
          "image": "text",
          "volume": "text",
          "path": "text",
          "keepFiles": true
        },
        "ports": [
          {
            "id": "text",
            "internal": 1,
            "external": 1
          }
        ],
        "portRanges": [
          {
            "id": "text",
            "internal": {
              "from": 1,
              "to": 1
            },
            "external": {
              "from": 1,
              "to": 1
            }
          }
        ],
        "volumes": [
          {
            "type": "ro",
            "id": "text",
            "name": "text",
            "path": "text",
            "size": "text",
            "class": "text"
          }
        ],
        "commands": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "args": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "initContainers": [
          {
            "id": "text",
            "name": "text",
            "image": "text",
            "command": [
              {
                "id": "text",
                "key": "text"
              }
            ],
            "args": [
              {
                "id": "text",
                "key": "text"
              }
            ],
            "environment": [
              {
                "value": "text",
                "id": "text",
                "key": "text"
              }
            ],
            "useParentConfig": true,
            "volumes": [
              {
                "id": "text",
                "name": "text",
                "path": "text"
              }
            ]
          }
        ],
        "capabilities": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "storage": {
          "storageId": "text",
          "path": "text",
          "bucket": "text"
        },
        "logConfig": {
          "driver": "nodeDefault",
          "options": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ]
        },
        "networks": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "dockerLabels": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "customHeaders": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "proxyHeaders": true,
        "useLoadBalancer": true,
        "extraLBAnnotations": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "healthCheckConfig": {
          "port": 1,
          "livenessProbe": "text",
          "readinessProbe": "text",
          "startupProbe": "text"
        },
        "resourceConfig": {
          "limits": {
            "cpu": "text",
            "memory": "text"
          },
          "requests": {
            "cpu": "text",
            "memory": "text"
          }
        },
        "annotations": {
          "service": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "deployment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "ingress": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ]
        },
        "labels": {
          "service": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "deployment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "ingress": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ]
        }
      }
    }
  ],
  "lastTry": 1,
  "token": {
    "id": "text",
    "name": "text",
    "createdAt": "2025-03-09T15:03:42.338Z",
    "expiresAt": "2025-03-09T15:03:42.338Z"
  }
}

Details of a deployment.

Delete deployment.

Request must include teamSlug and deploymentId in the URL.

delete

/api/{teamSlug}/deployments/{deploymentId}

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/deployments/{deploymentId}'

204

403

404

204

No body

Deployment deleted.

Update deployment.

Request must include deploymentId and teamSlug in URL.

patch

/api/{teamSlug}/deployments/{deploymentId}

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Body

notestring | nullable

prefixstring | nullable

environmentobject[] | nullable

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/{teamSlug}/deployments/{deploymentId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "note": "text",
    "prefix": "text",
    "environment": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ]
  }'

204

400

403

404

204

No body

Deployment modified.

Get details of a soon-to-be container.

Request must include teamSlug, deploymentId and instanceId, which refer to the ID of a deployment and the instance, in the URL. Instances are the manifestation of an image in the deployment. Response should include state, id, updatedAt, and image details including id, name, tag, order and config variables.

get

/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

instanceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}'

200

400

403

404

200

{
  "id": "text",
  "updatedAt": "2025-03-09T15:03:42.338Z",
  "image": {
    "id": "text",
    "name": "text",
    "tag": "text",
    "order": 1,
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": true,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": true,
        "uploadLimit": "text"
      },
      "user": 1,
      "tty": true,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": true
      },
      "ports": [
        {
          "id": "text",
          "internal": 1,
          "external": 1
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 1,
            "to": 1
          },
          "external": {
            "from": 1,
            "to": 1
          }
        }
      ],
      "volumes": [
        {
          "type": "ro",
          "id": "text",
          "name": "text",
          "path": "text",
          "size": "text",
          "class": "text"
        }
      ],
      "commands": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "args": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "initContainers": [
        {
          "id": "text",
          "name": "text",
          "image": "text",
          "command": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "args": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "useParentConfig": true,
          "volumes": [
            {
              "id": "text",
              "name": "text",
              "path": "text"
            }
          ]
        }
      ],
      "capabilities": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "storage": {
        "storageId": "text",
        "path": "text",
        "bucket": "text"
      },
      "logConfig": {
        "driver": "nodeDefault",
        "options": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "networks": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "dockerLabels": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "customHeaders": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "proxyHeaders": true,
      "useLoadBalancer": true,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 1,
        "livenessProbe": "text",
        "readinessProbe": "text",
        "startupProbe": "text"
      },
      "resourceConfig": {
        "limits": {
          "cpu": "text",
          "memory": "text"
        },
        "requests": {
          "cpu": "text",
          "memory": "text"
        }
      },
      "annotations": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "labels": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      }
    },
    "createdAt": "2025-03-09T15:03:42.338Z",
    "registry": {
      "type": "v2",
      "id": "text",
      "name": "text"
    }
  },
  "config": {
    "expose": "none",
    "restartPolicy": "always",
    "networkMode": "none",
    "deploymentStrategy": "recreate",
    "secrets": [
      {
        "required": true,
        "id": "text",
        "key": "text",
        "value": "text",
        "encrypted": true,
        "publicKey": "text"
      }
    ],
    "name": "text",
    "environment": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "routing": {
      "domain": "text",
      "path": "text",
      "stripPath": true,
      "uploadLimit": "text"
    },
    "user": 1,
    "tty": true,
    "configContainer": {
      "image": "text",
      "volume": "text",
      "path": "text",
      "keepFiles": true
    },
    "ports": [
      {
        "id": "text",
        "internal": 1,
        "external": 1
      }
    ],
    "portRanges": [
      {
        "id": "text",
        "internal": {
          "from": 1,
          "to": 1
        },
        "external": {
          "from": 1,
          "to": 1
        }
      }
    ],
    "volumes": [
      {
        "type": "ro",
        "id": "text",
        "name": "text",
        "path": "text",
        "size": "text",
        "class": "text"
      }
    ],
    "commands": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "args": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "initContainers": [
      {
        "id": "text",
        "name": "text",
        "image": "text",
        "command": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "args": [
          {
            "id": "text",
            "key": "text"
          }
        ],
        "environment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "useParentConfig": true,
        "volumes": [
          {
            "id": "text",
            "name": "text",
            "path": "text"
          }
        ]
      }
    ],
    "capabilities": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "storage": {
      "storageId": "text",
      "path": "text",
      "bucket": "text"
    },
    "logConfig": {
      "driver": "nodeDefault",
      "options": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ]
    },
    "networks": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "dockerLabels": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "customHeaders": [
      {
        "id": "text",
        "key": "text"
      }
    ],
    "proxyHeaders": true,
    "useLoadBalancer": true,
    "extraLBAnnotations": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "healthCheckConfig": {
      "port": 1,
      "livenessProbe": "text",
      "readinessProbe": "text",
      "startupProbe": "text"
    },
    "resourceConfig": {
      "limits": {
        "cpu": "text",
        "memory": "text"
      },
      "requests": {
        "cpu": "text",
        "memory": "text"
      }
    },
    "annotations": {
      "service": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "deployment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "ingress": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ]
    },
    "labels": {
      "service": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "deployment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "ingress": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ]
    }
  }
}

Details of an instance.

Update instance configuration.

Request must include teamSlug, deploymentId, instanceId in URL, and portion of the instance configuration as config in the body. Response should include config variables in an array.

patch

/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

instanceIdstringrequired

Body

configobjectrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "secrets": [
        {
          "required": true,
          "id": "text",
          "key": "text",
          "value": "text",
          "encrypted": true,
          "publicKey": "text"
        }
      ],
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": true,
        "uploadLimit": "text"
      },
      "user": 1,
      "tty": true,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": true
      },
      "ports": [
        {
          "id": "text",
          "internal": 1,
          "external": 1
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 1,
            "to": 1
          },
          "external": {
            "from": 1,
            "to": 1
          }
        }
      ],
      "volumes": [
        {
          "type": "ro",
          "id": "text",
          "name": "text",
          "path": "text",
          "size": "text",
          "class": "text"
        }
      ],
      "commands": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "args": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "initContainers": [
        {
          "id": "text",
          "name": "text",
          "image": "text",
          "command": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "args": [
            {
              "id": "text",
              "key": "text"
            }
          ],
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "useParentConfig": true,
          "volumes": [
            {
              "id": "text",
              "name": "text",
              "path": "text"
            }
          ]
        }
      ],
      "capabilities": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "storage": {
        "storageId": "text",
        "path": "text",
        "bucket": "text"
      },
      "logConfig": {
        "driver": "nodeDefault",
        "options": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "networks": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "dockerLabels": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "customHeaders": [
        {
          "id": "text",
          "key": "text"
        }
      ],
      "proxyHeaders": true,
      "useLoadBalancer": true,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 1,
        "livenessProbe": "text",
        "readinessProbe": "text",
        "startupProbe": "text"
      },
      "resourceConfig": {
        "limits": {
          "cpu": "text",
          "memory": "text"
        },
        "requests": {
          "cpu": "text",
          "memory": "text"
        }
      },
      "annotations": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      },
      "labels": {
        "service": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "deployment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "ingress": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ]
      }
    }
  }'

204

400

403

404

204

No body

Instance configuration updated.

Fetch secrets of a soon-to-be container.

Request must include teamSlug, deploymentId and instanceId, which refer to the ID of a deployment and the instance, needs to be included in URL. Response should include container prefix and name, and publicKey, keys.

get

/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}/secrets

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

instanceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}/secrets'

200

400

403

404

200

{
  "container": {
    "prefix": "text",
    "name": "text"
  },
  "publicKey": "text",
  "keys": [
    "text"
  ]
}

Secrets of an instance listed.

Start the deployment process.

Request must include teamSlug and deploymentId in the URL.

post

/api/{teamSlug}/deployments/{deploymentId}/start

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Body

instancesstring[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/deployments/{deploymentId}/start' \
  --header 'Content-Type: application/json' \
  --data '{
    "instances": [
      "text"
    ]
  }'

204

400

403

204

No body

Deployment initiated.

Copy deployment.

Request must include teamSlug and deploymentId in the URL, which will be copied. The body must include the nodeId, prefix and optionally a note. Response should include deployment data: id, prefix, status, note, and miscellaneous details of audit log, project, version, and node.

post

/api/{teamSlug}/deployments/{deploymentId}/copy

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Body

nodeIdstringrequired

prefixstringrequired

notestring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/deployments/{deploymentId}/copy' \
  --header 'Content-Type: application/json' \
  --data '{
    "nodeId": "text",
    "prefix": "text",
    "note": "text"
  }'

201

400

403

409

201

{
  "status": "preparing",
  "note": "text",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "project": {
    "type": "versionless",
    "id": "text",
    "name": "text"
  },
  "version": {
    "type": "incremental",
    "id": "text",
    "name": "text"
  },
  "node": {
    "type": "docker",
    "id": "text",
    "name": "text"
  },
  "id": "text",
  "prefix": "text"
}

Deployment copied.

Fetch event log of a deployment.

Request must include teamSlug and deploymentId in the URL. Response should include an items array with objects of type, deploymentStatus, createdAt, log, and containerState which consists of state and instanceId.

get

/api/{teamSlug}/deployments/{deploymentId}/log

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Query parameters

skipnumberrequired

takenumberrequired

trynumber

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/deployments/{deploymentId}/log?skip=1&take=1'

200

400

403

404

200

{
  "items": [
    {
      "type": "log",
      "deploymentStatus": "preparing",
      "createdAt": "2025-03-09T15:03:42.338Z",
      "log": [
        "text"
      ],
      "containerState": {
        "state": "running",
        "instanceId": "text"
      }
    }
  ],
  "total": 1
}

Deployment event log.

Create deployment token.

Request must include teamSlug and deploymentId in the URL. In the body a name and optionally the expiration date as expirationInDays.

put

/api/{teamSlug}/deployments/{deploymentId}/token

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Body

namestringrequired

expirationInDaysnumber

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/deployments/{deploymentId}/token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "expirationInDays": 1
  }'

200

201

400

403

409

200

{
  "id": "text",
  "name": "text",
  "createdAt": "2025-03-09T15:03:42.338Z",
  "expiresAt": "2025-03-09T15:03:42.338Z",
  "token": "text",
  "curl": "text"
}

Deployment token with jwt and the curl command.

Delete deployment token.

Request must include teamSlug and deploymentId in the URL.

delete

/api/{teamSlug}/deployments/{deploymentId}/token

Path parameters

teamSlugstringrequired

deploymentIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/deployments/{deploymentId}/token'

204

403

404

204

No body

Deployment token deleted.

Tokens

Tokens are the access tokens that grant you access to a user profile and the teams the profile is a member of.

List of tokens.

Access token's support is to provide secure access to the HTTP api without a cookie.

get

/api/tokens

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/tokens'

200

403

200

[
  {
    "id": "text",
    "name": "text",
    "expiresAt": "2025-03-09T15:03:42.338Z",
    "createdAt": "2025-03-09T15:03:42.338Z"
  }
]

Token list fetched.

Create access token.

Request must include name and expirationInDays.

post

/api/tokens

Body

namestringrequired

expirationInDaysnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/tokens' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "expirationInDays": 1
  }'

201

400

403

409

201

{
  "id": "text",
  "name": "text",
  "expiresAt": "2025-03-09T15:03:42.338Z",
  "createdAt": "2025-03-09T15:03:42.338Z",
  "token": "text"
}

Fetch token details.

Access token's details are name, id, and the time of creation and expiration. Request must include tokenId.

get

/api/tokens/{tokenId}

Path parameters

tokenIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/tokens/{tokenId}'

200

400

403

404

200

{
  "id": "text",
  "name": "text",
  "expiresAt": "2025-03-09T15:03:42.338Z",
  "createdAt": "2025-03-09T15:03:42.338Z"
}

Token details listed.

Delete an access token.

Request must include tokenId.

delete

/api/tokens/{tokenId}

Path parameters

tokenIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/tokens/{tokenId}'

204

403

404

204

No body

Delete token.

Nodes

Nodes are the deployment targets. Nodes are registered by installing at least one of the agents – crane for Kubernetes, dagent for Docker. These agents connect the platform to your node. One team can have as many nodes as they like.

Node installation takes place with Shell or PowerShell scripts, which can be created or revoked. More details here.

Get data of nodes that belong to your team.

Fetch data of deployment targets. Request must include teamSlug in URL. Response should include an array with the node's type, status, description, icon, address, connectedAt date, version, updating, id, and name.

get

/api/{teamSlug}/nodes

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/nodes'

200

403

200

[
  {
    "type": "docker",
    "status": "unreachable",
    "description": "text",
    "icon": "text",
    "address": "text",
    "connectedAt": "2025-03-09T15:03:42.338Z",
    "version": "text",
    "updating": true,
    "id": "text",
    "name": "text"
  }
]

Data of nodes listed.

Create new node.

Request must include the teamSlug in URL, and node's name in body. Response should include an array with the node's type, status, description, icon, address, connectedAt date, version, updating, id, and name.

post

/api/{teamSlug}/nodes

Path parameters

teamSlugstringrequired

Body

namestringrequired

descriptionstring

iconstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "icon": "text"
  }'

201

400

403

409

201

{
  "type": "docker",
  "status": "unreachable",
  "description": "text",
  "icon": "text",
  "address": "text",
  "connectedAt": "2025-03-09T15:03:42.338Z",
  "version": "text",
  "updating": true,
  "id": "text",
  "name": "text"
}

New node created.

Get data of nodes that belong to your team.

Fetch data of a specific node. Request must include teamSlug in URL, and nodeId in body. Response should include an array with the node's type, status, description, icon, address, connectedAt date, version, updating, id, name, hasToken, and agent installation details.

get

/api/{teamSlug}/nodes/{nodeId}

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/nodes/{nodeId}'

200

400

403

404

200

{
  "type": "docker",
  "status": "unreachable",
  "description": "text",
  "icon": "text",
  "address": "text",
  "connectedAt": "2025-03-09T15:03:42.338Z",
  "version": "text",
  "updating": true,
  "id": "text",
  "name": "text",
  "hasToken": true,
  "install": {
    "command": "text",
    "script": "text",
    "expireAt": "2025-03-09T15:03:42.338Z"
  },
  "inUse": true
}

Data of the node.

Update details of a node.

Request must include the teamSlug in URL, and node's name in body, body can include description and icon.

put

/api/{teamSlug}/nodes/{nodeId}

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Body

namestringrequired

descriptionstring

iconstring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/nodes/{nodeId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "icon": "text"
  }'

204

400

403

404

409

204

No body

Node details modified.

Delete node.

Request must include the teamSlug in URL, and node's name in body.

delete

/api/{teamSlug}/nodes/{nodeId}

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/nodes/{nodeId}'

204

403

404

204

No body

Node deleted.

Fetch install script.

Request must include the teamSlug in URL, and node's name in body. Response should include type, status, description, icon, address, connectedAt date, version, updating, id, name, hasToken, and install details.

get

/api/{teamSlug}/nodes/{nodeId}/script

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Responses

text/plain

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/nodes/{nodeId}/script'

200

400

403

404

200

text

Create agent install script.

Request must include teamSlug in URL and nodeId, type, and scriptType.

post

/api/{teamSlug}/nodes/{nodeId}/script

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Body

typestring · enumrequired

Options: docker, k8s

scriptTypestring · enumrequired

Options: shell, powershell

rootPathstring

dagentTraefikobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/script' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "docker",
    "scriptType": "shell",
    "rootPath": "text",
    "dagentTraefik": {
      "acmeEmail": "text"
    }
  }'

200

201

400

403

200

{
  "command": "text",
  "script": "text",
  "expireAt": "2025-03-09T15:03:42.338Z"
}

Install script generated.

Delete node set up install script.

Request must include the teamSlug in URL, and node's name in body.

delete

/api/{teamSlug}/nodes/{nodeId}/script

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/nodes/{nodeId}/script'

204

403

404

204

No body

Agent install script deleted.

Revoke the node's access token.

Request must include the teamSlug in URL, and node's name in body.

delete

/api/{teamSlug}/nodes/{nodeId}/token

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/nodes/{nodeId}/token'

204

403

404

204

No body

Token revoked.

Update the agent.

Request must include the teamSlug in URL, and node's name in body.

post

/api/{teamSlug}/nodes/{nodeId}/update

Path parameters

nodeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/update'

204

400

403

204

No body

Node details modified.

Fetch audit log.

Request must include teamSlug in URL, and its body must include skip, take, and dates of from and to. Response should include an array of items: createdAt date, event, and data.

get

/api/{teamSlug}/nodes/{nodeId}/audit

Path parameters

teamSlugstringrequired

nodeIdstringrequired

Query parameters

skipnumberrequired

takenumberrequired

fromstring · date-timerequired

tostring · date-timerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/nodes/{nodeId}/audit?skip=1&take=1&from=2025-03-09T15%3A03%3A42.338Z&to=2025-03-09T15%3A03%3A42.338Z'

200

400

403

404

200

{
  "items": [
    {
      "createdAt": "2025-03-09T15:03:42.338Z",
      "event": "text",
      "data": {}
    }
  ],
  "total": 1
}

Paginated list of the audit log.

Start a container deployed with dyrector.io on a node.

Request must include nodeId, prefix, and name.

post

/api/{teamSlug}/nodes/{nodeId}//{prefix}/containers/{name}/start

Path parameters

nodeIdstringrequired

prefixstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}/start'

204

400

403

204

No body

Container started.

Stop a container deployed with dyrector.io on a node.

Request must include nodeId, prefix, and name.

post

/api/{teamSlug}/nodes/{nodeId}//{prefix}/containers/{name}/stop

Path parameters

nodeIdstringrequired

prefixstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}/stop'

204

400

403

204

No body

Container stopped.

Restart a container deployed with dyrector.io on a node.

Request must include nodeId, prefix, and name.

post

/api/{teamSlug}/nodes/{nodeId}//{prefix}/containers/{name}/restart

Path parameters

nodeIdstringrequired

prefixstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}/restart'

204

400

403

204

No body

Container restarted.

Delete containers deployed with dyrector.io, with the specified prefix on a node.

Request must include nodeId, and prefix.

delete

/api/{teamSlug}/nodes/{nodeId}//{prefix}/containers

Path parameters

nodeIdstringrequired

prefixstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers'

204

403

404

204

No body

Containers deleted.

Delete a container deployed with dyrector.io, with the specified prefix and name on a node.

Request must include nodeId, prefix, and name.

delete

/api/{teamSlug}/nodes/{nodeId}//{prefix}/containers/{name}

Path parameters

nodeIdstringrequired

prefixstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}'

204

403

404

204

No body

Container deleted.

Fetch data of all containers on a node.

Request must include nodeId and prefix. Response should include id, command, createdAt, state, status, imageName, imageTag and ports of images.

get

/api/{teamSlug}/nodes/{nodeId}/containers

Path parameters

nodeIdstringrequired

Query parameters

prefixstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/nodes/{nodeId}/containers?prefix=text'

200

403

200

[
  {
    "state": "running",
    "id": {
      "prefix": "text",
      "name": "text"
    },
    "command": "text",
    "createdAt": "2025-03-09T15:03:42.338Z",
    "reason": "text",
    "imageName": "text",
    "imageTag": "text",
    "ports": [
      {
        "internal": 1,
        "external": 1
      }
    ]
  }
]

Fetch data of containers running on a node.

Start the specific container on a node.

Request must include nodeId, and the name of the container.

post

/api/{teamSlug}/nodes/{nodeId}/containers/{name}/start

Path parameters

nodeIdstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/containers/{name}/start'

204

400

403

204

No body

Container started.

Stop the specific container on a node.

Request must include nodeId, and the name of the container.

post

/api/{teamSlug}/nodes/{nodeId}/containers/{name}/stop

Path parameters

nodeIdstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/containers/{name}/stop'

204

400

403

204

No body

Container stopped.

Restart the specific container on a node.

Request must include nodeId, and the name of the container.

post

/api/{teamSlug}/nodes/{nodeId}/containers/{name}/restart

Path parameters

nodeIdstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/nodes/{nodeId}/containers/{name}/restart'

204

400

403

204

No body

Container restarted.

Delete the specific container from a node.

Request must include nodeId, and the name of the container.

delete

/api/{teamSlug}/nodes/{nodeId}/containers/{name}

Path parameters

nodeIdstringrequired

namestringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/nodes/{nodeId}/containers/{name}'

204

403

404

204

No body

Container deleted.

Audit log

Audit log is a log of team activity generated by the platform.

Fetch audit log.

Request must include skip, take, and dates of from and to. Response should include an array of items: createdAt date, userId, email, serviceCall, and data.

get

/api/{teamSlug}/audit-log

Path parameters

teamSlugstringrequired

Query parameters

skipnumberrequired

takenumberrequired

filterstring

fromstring · date-timerequired

tostring · date-timerequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/audit-log?skip=1&take=1&from=2025-03-09T15%3A03%3A42.338Z&to=2025-03-09T15%3A03%3A42.338Z'

200

403

200

{
  "items": [
    {
      "actorType": "get",
      "context": "http",
      "method": "get",
      "createdAt": "2025-03-09T15:03:42.338Z",
      "user": {
        "id": "text",
        "email": "text"
      },
      "name": "text",
      "event": "text",
      "data": {}
    }
  ],
  "total": 1
}

Paginated list of the audit log.

Health

Health refers to the status of the different services that make up the platform. It can be checked to see if the platform works properly.

Return service status of the platform.

Response should include status, version of the platform and lastMigration of database.

get

/api/health

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/health'

200

200

{
  "status": {},
  "version": "text",
  "lastMigration": "text"
}

Service status.

Notifications

Notifications are chat notifications in Slack, Discord, and Teams. They send an automated message about deployments, new versions, new nodes, and new users. More details here.

Retrieve notifications that belong to a team.

Response should include teamSlug in the URL, type, id, name, url, active, and creatorName in the body.

get

/api/{teamSlug}/notifications

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/notifications'

200

403

200

[
  {
    "type": "discord",
    "id": "text",
    "name": "text",
    "url": "text",
    "active": true,
    "creatorName": "text"
  }
]

Notifications listed.

Create a new notification.

Request must include teamSlug in the URL, type, enabledEvents, id, name, url, and active in the body. Response should list type, enabledEvents, id, name, url, active, and creatorName.

post

/api/{teamSlug}/notifications

Path parameters

teamSlugstringrequired

Body

typestring · enumrequired

Options: discord, slack, teams

enabledEventsstring · enum[]required

namestringrequired

urlstringrequired

activebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "discord",
    "enabledEvents": [
      "deployment-created"
    ],
    "name": "text",
    "url": "text",
    "active": true
  }'

201

400

403

409

201

{
  "type": "discord",
  "enabledEvents": [
    "deployment-created"
  ],
  "id": "text",
  "name": "text",
  "url": "text",
  "active": true,
  "creatorName": "text"
}

New notification created.

Fetch details of a notification.

Request must include teamSlug and notificationId parameters in URL. Response should include type, enabledEvents, id, name, url, active, and creatorName.

get

/api/{teamSlug}/notifications/{notificationId}

Path parameters

teamSlugstringrequired

notificationIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/notifications/{notificationId}'

200

400

403

404

200

{
  "type": "discord",
  "enabledEvents": [
    "deployment-created"
  ],
  "id": "text",
  "name": "text",
  "url": "text",
  "active": true,
  "creatorName": "text"
}

Details of notification listed.

Modify a notification.

Request must include teamSlug in the URL, type, enabledEvents, id, name, url, and active in the body. Response should include type, enabledEvents, id, name, url, active, and creatorName.

put

/api/{teamSlug}/notifications/{notificationId}

Path parameters

teamSlugstringrequired

notificationIdstringrequired

Body

typestring · enumrequired

Options: discord, slack, teams

enabledEventsstring · enum[]required

namestringrequired

urlstringrequired

activebooleanrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/notifications/{notificationId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "discord",
    "enabledEvents": [
      "deployment-created"
    ],
    "name": "text",
    "url": "text",
    "active": true
  }'

200

204

400

403

404

409

200

{
  "type": "discord",
  "enabledEvents": [
    "deployment-created"
  ],
  "id": "text",
  "name": "text",
  "url": "text",
  "active": true,
  "creatorName": "text"
}

Notification modified.

Delete a notification.

Request must include teamSlug and notificationId in URL.

delete

/api/{teamSlug}/notifications/{notificationId}

Path parameters

teamSlugstringrequired

notificationIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/notifications/{notificationId}'

204

403

404

204

No body

Notification deleted.

Send a test message.

Request must include teamSlug and notificationId in URL.

post

/api/{teamSlug}/notifications/{notificationId}/test

Path parameters

teamSlugstringrequired

notificationIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/notifications/{notificationId}/test'

204

400

403

204

No body

Test message sent.

Templates

Templates are preset applications that can be turned into a project right away. They can be deployed with minimal configuration. More details about templates here.

Return list of templates on the platform.

Response should include id, name, description and technologies of templates.

get

/api/templates

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/templates'

200

403

200

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "technologies": [
      "text"
    ]
  }
]

Templates listed.

Creates a new project from the selected template.

Request must include type, id, and name. Response should include id, name, description, type, and audit log details of templates.

post

/api/templates

Body

typestring · enumrequired

Options: versionless, versioned

idstringrequired

teamSlugstringrequired

namestringrequired

descriptionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/templates' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "versionless",
    "id": "text",
    "teamSlug": "text",
    "name": "text",
    "description": "text"
  }'

201

400

403

409

201

{
  "type": "versionless",
  "description": "text",
  "audit": {
    "createdAt": "2025-03-09T15:03:42.338Z",
    "createdBy": "text",
    "updatedAt": "2025-03-09T15:03:42.338Z",
    "updatedBy": "text"
  },
  "id": "text",
  "name": "text"
}

New project created.

Retrieves the picture of the template

Request must include templateId.

get

/api/templates/{templateId}/image

Path parameters

templateIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/templates/{templateId}/image'

200

400

403

404

200

No body

Retrieve data of an image of a template.

Dashboard

Dashboard summarizes the latest activities of a team.

Fetch dashboard data of latest activities.

teamSlug is required in URL. Response should include users, number of auditLogEntries, projects, versions, deployments, failedDeployments, details of nodes, latestDeployments and auditLog entries.

get

/api/{teamSlug}/dashboard

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/dashboard'

200

403

200

{
  "users": 1,
  "auditLog": 1,
  "projects": 1,
  "versions": 1,
  "deployments": 1,
  "failedDeployments": 1,
  "onboarding": {
    "signUp": {
      "done": true,
      "resourceId": "text"
    },
    "createTeam": {
      "done": true,
      "resourceId": "text"
    },
    "createNode": {
      "done": true,
      "resourceId": "text"
    },
    "createProject": {
      "done": true,
      "resourceId": "text"
    },
    "createVersion": {
      "done": true,
      "resourceId": "text"
    },
    "addImages": {
      "done": true,
      "resourceId": "text"
    },
    "addDeployment": {
      "done": true,
      "resourceId": "text"
    },
    "deploy": {
      "done": true,
      "resourceId": "text"
    }
  }
}

Dashboard data listed.

Storages

Storages are S3 compatible memory storages. They can be used for file injection. More details here.

Fetch the list of storages.

Response should include description, icon, url, id, and name. teamSlug is required in URL.

get

/api/{teamSlug}/storages

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/storages'

200

403

200

[
  {
    "description": "text",
    "icon": "text",
    "url": "text",
    "id": "text",
    "name": "text"
  }
]

List of storages.

Create a new storage.

Creates a new storage. Request must include teamSlug in URL, body is required to include name, and url. Request body may include description, icon, accesKey, and secretKey. Response should include description, icon, url, id, name, accessKey, secretKey, and inUse.

post

/api/{teamSlug}/storages

Path parameters

teamSlugstringrequired

Body

namestringrequired

descriptionstring

iconstring

urlstringrequired

accessKeystring

secretKeystring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/{teamSlug}/storages' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "icon": "text",
    "url": "text",
    "accessKey": "text",
    "secretKey": "text"
  }'

201

400

403

409

201

{
  "description": "text",
  "icon": "text",
  "url": "text",
  "id": "text",
  "name": "text",
  "accessKey": "text",
  "secretKey": "text",
  "inUse": true
}

New storage created.

Fetch the name and ID of available storage options.

Response should include id, and name. teamSlug is required in URL.

get

/api/{teamSlug}/storages/options

Path parameters

teamSlugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/storages/options'

200

400

403

404

200

[
  {
    "id": "text",
    "name": "text"
  }
]

Name and ID of storage options listed.

Return details of a storage.

Get the details of a storage. Request must include teamSlug and storageId in URL. Response should include description, icon, url, id, name, accessKey, secretKey, and inUse.

get

/api/{teamSlug}/storages/{storageId}

Path parameters

teamSlugstringrequired

storageIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/{teamSlug}/storages/{storageId}'

200

400

403

404

200

{
  "description": "text",
  "icon": "text",
  "url": "text",
  "id": "text",
  "name": "text",
  "accessKey": "text",
  "secretKey": "text",
  "inUse": true
}

Storage details.

Modify a storage.

Updates a storage. Request must include teamSlugand storageId in URL. name, and url must be included in body. Request body may include description, icon, accesKey, and secretKey.

put

/api/{teamSlug}/storages/{storageId}

Path parameters

teamSlugstringrequired

storageIdstringrequired

Body

namestringrequired

descriptionstring

iconstring

urlstringrequired

accessKeystring

secretKeystring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/{teamSlug}/storages/{storageId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "icon": "text",
    "url": "text",
    "accessKey": "text",
    "secretKey": "text"
  }'

204

400

403

404

409

204

No body

Storage updated.

Delete a storage from dyrector.io.

Deletes a storage. Request must include teamSlug and storageId in URL.

delete

/api/{teamSlug}/storages/{storageId}

Path parameters

teamSlugstringrequired

storageIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/{teamSlug}/storages/{storageId}'

204

403

404

204

No body

Storage deleted.