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.Registries are 3rd party registries where the container images are stored.

GET/api/{teamSlug}/registries

Path parameters

teamSlug*string

Response

200403

Data of all registries within a team listed.

Body

application/json

type*enum

v2hubgitlabgithubgoogleunchecked

id*string

name*string

descriptionnullable string

iconnullable string

url*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/registries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

Body

application/json

type*enum

groupproject

details*one of

HubRegistryDetailsDto (object)V2RegistryDetailsDto (object)GitlabRegistryDetailsDto (object)GithubRegistryDetailsDto (object)GoogleRegistryDetailsDto (object)UncheckedRegistryDetailsDto (object)

name*string

descriptionnullable string

iconnullable string

Response

201400403409

New registry created.

Headers

Body

application/json

type*enum

groupproject

details*one of

HubRegistryDetailsDto (object)V2RegistryDetailsDto (object)GitlabRegistryDetailsDto (object)GithubRegistryDetailsDto (object)GoogleRegistryDetailsDto (object)UncheckedRegistryDetailsDto (object)

id*string

name*string

descriptionnullable string

iconnullable string

inUse*boolean

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/registries', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "group",
      "details": {
        "imageNamePrefix": "text"
      },
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "group",
  "details": {
    "imageNamePrefix": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "icon": "text",
  "inUse": false,
  "createdAt": "2024-04-19T13:33:57.589Z",
  "updatedAt": "2024-04-19T13:33:57.589Z"
}

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

teamSlug*string

registryId*string

Response

200400403404

Data of a registry listed.

Body

application/json

type*enum

groupproject

details*one of

HubRegistryDetailsDto (object)V2RegistryDetailsDto (object)GitlabRegistryDetailsDto (object)GithubRegistryDetailsDto (object)GoogleRegistryDetailsDto (object)UncheckedRegistryDetailsDto (object)

id*string

name*string

descriptionnullable string

iconnullable string

inUse*boolean

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/registries/{registryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "group",
  "details": {
    "imageNamePrefix": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "icon": "text",
  "inUse": false,
  "createdAt": "2024-04-19T13:33:57.589Z",
  "updatedAt": "2024-04-19T13:33:57.589Z"
}

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

teamSlug*string

registryId*string

Body

application/json

type*enum

groupproject

details*one of

HubRegistryDetailsDto (object)V2RegistryDetailsDto (object)GitlabRegistryDetailsDto (object)GithubRegistryDetailsDto (object)GoogleRegistryDetailsDto (object)UncheckedRegistryDetailsDto (object)

name*string

descriptionnullable string

iconnullable string

Response

204400403404409

Registry modified.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/registries/{registryId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "group",
      "details": {
        "imageNamePrefix": "text"
      },
      "name": "text"
    }),
});
const data = await response.json();

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

teamSlug*string

registryId*string

Response

204403404

Registry deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/registries/{registryId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

Response

200403

List of projects.

Body

application/json

type*enum

versionlessversioned

descriptionnullable string

versionCountnumber

audit*AuditDto (object)

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": "versionless",
    "description": "text",
    "versionCount": 0,
    "audit": {
      "createdAt": "2024-04-19T13:33:57.589Z",
      "createdBy": "text",
      "updatedAt": "2024-04-19T13:33:57.589Z",
      "updatedBy": "text"
    },
    "id": "text",
    "name": "text"
  }
]

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

teamSlug*string

Body

application/json

type*enum

versionlessversioned

name*string

descriptionnullable string

changelognullable string

Response

201400403409

New project created.

Body

application/json

type*enum

versionlessversioned

descriptionnullable string

versionCountnumber

audit*AuditDto (object)

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "versionless",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "versionless",
  "description": "text",
  "versionCount": 0,
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "updatedBy": "text"
  },
  "id": "text",
  "name": "text"
}

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

teamSlug*string

projectId*string

Response

200400403404

Details of a project.

Body

application/json

type*enum

versionlessversioned

descriptionnullable string

deletable*boolean

versions*array of VersionDto (object)

audit*AuditDto (object)

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "versionless",
  "description": "text",
  "deletable": false,
  "versions": [
    {
      "type": "incremental",
      "audit": {
        "createdAt": "2024-04-19T13:33:57.589Z",
        "createdBy": "text",
        "updatedAt": "2024-04-19T13:33:57.589Z",
        "updatedBy": "text"
      },
      "changelog": "text",
      "default": false,
      "increasable": false,
      "id": "text",
      "name": "text"
    }
  ],
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "updatedBy": "text"
  },
  "id": "text",
  "name": "text"
}

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

teamSlug*string

projectId*string

Body

application/json

name*string

descriptionnullable string

changelognullable string

Response

204400403404409

Project details are modified.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Delete a project.

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

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

Path parameters

teamSlug*string

projectId*string

Response

204403404

Project deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

projectId*string

Response

204400403

Project converted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/convert', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

projectId*string

Query parameters

Response

200403

Returns an array with every versions of a project.

Body

application/json

type*enum

incrementalrolling

audit*AuditDto (object)

changelogstring

default*boolean

increasable*boolean

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": "incremental",
    "audit": {
      "createdAt": "2024-04-19T13:33:57.589Z",
      "createdBy": "text",
      "updatedAt": "2024-04-19T13:33:57.589Z",
      "updatedBy": "text"
    },
    "changelog": "text",
    "default": false,
    "increasable": false,
    "id": "text",
    "name": "text"
  }
]

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

teamSlug*string

projectId*string

Body

application/json

type*enum

incrementalrolling

name*string

changelogstring

Response

201400403409

New version created.

Body

application/json

type*enum

incrementalrolling

audit*AuditDto (object)

changelogstring

default*boolean

increasable*boolean

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "incremental",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "incremental",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "updatedBy": "text"
  },
  "changelog": "text",
  "default": false,
  "increasable": false,
  "id": "text",
  "name": "text"
}

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

teamSlug*string

projectId*string

versionId*string

Response

200400403404

Details of a version under a project is fetched.

Body

application/json

type*enum

incrementalrolling

audit*AuditDto (object)

changelogstring

default*boolean

increasable*boolean

id*string

name*string

mutable*boolean

deletable*boolean

images*array of ImageDto (object)

deployments*array of DeploymentWithBasicNodeDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "incremental",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "updatedBy": "text"
  },
  "changelog": "text",
  "default": false,
  "increasable": false,
  "id": "text",
  "name": "text",
  "mutable": false,
  "deletable": false,
  "images": [
    {
      "id": "text",
      "name": "text",
      "tag": "text",
      "order": 0,
      "config": {
        "expose": "none",
        "restartPolicy": "always",
        "networkMode": "none",
        "deploymentStrategy": "recreate",
        "name": "text",
        "environment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "secrets": [
          {
            "required": false,
            "id": "text",
            "key": "text"
          }
        ],
        "routing": {
          "domain": "text",
          "path": "text",
          "stripPath": false,
          "uploadLimit": "text"
        },
        "user": 0,
        "tty": false,
        "configContainer": {
          "image": "text",
          "volume": "text",
          "path": "text",
          "keepFiles": false
        },
        "ports": [
          {
            "id": "text",
            "internal": 0,
            "external": 0
          }
        ],
        "portRanges": [
          {
            "id": "text",
            "internal": {
              "from": 0,
              "to": 0
            },
            "external": {
              "from": 0,
              "to": 0
            }
          }
        ],
        "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": false,
            "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": false,
        "useLoadBalancer": false,
        "extraLBAnnotations": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "healthCheckConfig": {
          "port": 0,
          "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": "2024-04-19T13:33:57.589Z",
      "registry": {
        "type": "v2",
        "id": "text",
        "name": "text"
      }
    }
  ],
  "deployments": [
    {
      "status": "preparing",
      "note": "text",
      "updatedAt": "2024-04-19T13:33:57.589Z",
      "node": {
        "type": "docker",
        "status": "unreachable",
        "id": "text",
        "name": "text"
      },
      "id": "text",
      "prefix": "text"
    }
  ]
}

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

teamSlug*string

projectId*string

versionId*string

Body

application/json

name*string

changelogstring

Response

204400403404409

Changelog of a version is updated.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

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

teamSlug*string

projectId*string

versionId*string

Response

204403404

Version deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

projectId*string

versionId*string

Response

204400403404

Version turned into default.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/default', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

projectId*string

versionId*string

Body

application/json

name*string

changelogstring

Response

201400403

New version created.

Body

application/json

type*enum

incrementalrolling

audit*AuditDto (object)

changelogstring

default*boolean

increasable*boolean

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/increase', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "incremental",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "updatedBy": "text"
  },
  "changelog": "text",
  "default": false,
  "increasable": false,
  "id": "text",
  "name": "text"
}

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.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

teamSlug*string

projectId*string

versionId*string

Response

200403

Data of images listed.

Body

application/json

id*string

name*string

tagnullable string

order*number

config*ContainerConfigDto (object)

createdAt*string (date-time)

registry*BasicRegistryDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "tag": "text",
    "order": 0,
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": false,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": false,
        "uploadLimit": "text"
      },
      "user": 0,
      "tty": false,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": false
      },
      "ports": [
        {
          "id": "text",
          "internal": 0,
          "external": 0
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 0,
            "to": 0
          },
          "external": {
            "from": 0,
            "to": 0
          }
        }
      ],
      "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": false,
          "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": false,
      "useLoadBalancer": false,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 0,
        "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": "2024-04-19T13:33:57.589Z",
    "registry": {
      "type": "v2",
      "id": "text",
      "name": "text"
    }
  }
]

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

teamSlug*string

projectId*string

versionId*string

Body

application/json

registryId*string

images*array of string

Response

201400403

New image added.

Body

application/json

id*string

name*string

tagnullable string

order*number

config*ContainerConfigDto (object)

createdAt*string (date-time)

registry*BasicRegistryDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "registryId": "text",
        "images": [
          "text"
        ]
      }
    ]),
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "tag": "text",
    "order": 0,
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": false,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": false,
        "uploadLimit": "text"
      },
      "user": 0,
      "tty": false,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": false
      },
      "ports": [
        {
          "id": "text",
          "internal": 0,
          "external": 0
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 0,
            "to": 0
          },
          "external": {
            "from": 0,
            "to": 0
          }
        }
      ],
      "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": false,
          "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": false,
      "useLoadBalancer": false,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 0,
        "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": "2024-04-19T13:33:57.589Z",
    "registry": {
      "type": "v2",
      "id": "text",
      "name": "text"
    }
  }
]

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.Image details consists name, id, tag, order, and the config of the image.

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

Path parameters

teamSlug*string

projectId*string

versionId*string

imageId*string

Response

200400403404

Data of an image.

Body

application/json

id*string

name*string

tagnullable string

order*number

config*ContainerConfigDto (object)

createdAt*string (date-time)

registry*BasicRegistryDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "tag": "text",
  "order": 0,
  "config": {
    "expose": "none",
    "restartPolicy": "always",
    "networkMode": "none",
    "deploymentStrategy": "recreate",
    "name": "text",
    "environment": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "secrets": [
      {
        "required": false,
        "id": "text",
        "key": "text"
      }
    ],
    "routing": {
      "domain": "text",
      "path": "text",
      "stripPath": false,
      "uploadLimit": "text"
    },
    "user": 0,
    "tty": false,
    "configContainer": {
      "image": "text",
      "volume": "text",
      "path": "text",
      "keepFiles": false
    },
    "ports": [
      {
        "id": "text",
        "internal": 0,
        "external": 0
      }
    ],
    "portRanges": [
      {
        "id": "text",
        "internal": {
          "from": 0,
          "to": 0
        },
        "external": {
          "from": 0,
          "to": 0
        }
      }
    ],
    "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": false,
        "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": false,
    "useLoadBalancer": false,
    "extraLBAnnotations": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "healthCheckConfig": {
      "port": 0,
      "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": "2024-04-19T13:33:57.589Z",
  "registry": {
    "type": "v2",
    "id": "text",
    "name": "text"
  }
}

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

teamSlug*string

projectId*string

versionId*string

imageId*string

Response

204403404

Delete an image from a version.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

projectId*string

versionId*string

imageId*string

Body

application/json

tagnullable string

confignullable all of

Response

204400403404

Image's configure variables updated.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/{imageId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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

teamSlug*string

projectId*string

versionId*string

Body

application/json

itemsstring

Response

204400403

Image order modified.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/projects/{projectId}/versions/{versionId}/images/order', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

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.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

Response

200403

List of teams and their statistics.

Body

application/json

statistics*TeamStatisticsDto (object)

id*string

name*string

slug*string

Request

JavaScriptCurl

const response = await fetch('/api/teams', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

application/json

slug*string

name*string

Response

201400403409

New team created.

Headers

Body

application/json

statistics*TeamStatisticsDto (object)

id*string

name*string

slug*string

Request

JavaScriptCurl

const response = await fetch('/api/teams', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "slug": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

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

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

teamId*string

Response

200400403404

Details of the team.

Body

application/json

statistics*TeamStatisticsDto (object)

id*string

name*string

slug*string

users*array of UserDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "statistics": {
    "users": 0,
    "projects": 0,
    "nodes": 0,
    "versions": 0,
    "deployments": 0
  },
  "id": "text",
  "name": "text",
  "slug": "text",
  "users": [
    {
      "role": "owner",
      "status": "pending",
      "email": "text",
      "lastLogin": "2024-04-19T13:33:57.589Z",
      "id": "text",
      "name": "text"
    }
  ]
}

Modify a team's name.

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

PUT/api/teams/{teamId}

Path parameters

teamId*string

Body

application/json

slug*string

name*string

Response

204400403404409

Team name modified.

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "slug": "text",
      "name": "text"
    }),
});
const data = await response.json();

Deletes a team.

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

DELETE/api/teams/{teamId}

Path parameters

teamId*string

Response

204403404

Team deleted.

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Invite a new user to the team.

Request must include teamId, email and firstName. Admin access required for a successful request.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

teamId*string

Body

application/json

email*string

firstName*string

lastNamestring

captchastring

Response

201400403409

User invited.

Headers

Body

application/json

role*enum

owneradminuser

status*enum

pendingverifiedexpireddeclined

email*string

lastLoginstring (date-time)

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "firstName": "text"
    }),
});
const data = await response.json();

Response

{
  "role": "owner",
  "status": "pending",
  "email": "text",
  "lastLogin": "2024-04-19T13:33:57.589Z",
  "id": "text",
  "name": "text"
}

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

teamId*string

userId*string

Body

application/json

role*enum

owneradminuser

Response

204400403404

User's role modified.

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}/users/{userId}/role', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "role": "owner"
    }),
});
const data = await response.json();

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

teamId*string

Response

204403404

User removed from a team.

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}/users/leave', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamId*string

userId*string

Response

204403404

User removed from a team.

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}/users/{userId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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.Request must include teamId, userId. Admin access required for a successful request.

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

Path parameters

teamId*string

userId*string

Response

204400403

New invite link sent.

Request

JavaScriptCurl

const response = await fetch('/api/teams/{teamId}/users/{userId}/reinvite', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

Response

200400403

Fetch the current user.

Body

application/json

user*BasicUserDto (object)

teams*array of UserMetaTeamDto (object)

invitations*array of BasicTeamDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/users/me', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

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

Accept invitation to a team.

Request must include teamId.

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

Path parameters

teamId*string

Response

204400403

Invitation accepted.

Request

JavaScriptCurl

const response = await fetch('/api/users/me/invitations/{teamId}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Decline invitation to a team.

Request must include teamId.

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

Path parameters

teamId*string

Response

204403404

Invitation declined.

Request

JavaScriptCurl

const response = await fetch('/api/users/me/invitations/{teamId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Sets the onboarding tips to visible for the user.

Enable onboarding tips.

PUT/api/users/me/preferences/onboarding

Response

204403

Enabled.

Request

JavaScriptCurl

const response = await fetch('/api/users/me/preferences/onboarding', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Sets the onboarding tips to hidden for the user.

Disable onboarding tips.

DELETE/api/users/me/preferences/onboarding

Response

204403

Disabled.

Request

JavaScriptCurl

const response = await fetch('/api/users/me/preferences/onboarding', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

Response

200403

List of deployments.

Body

application/json

status*enum

preparingin-progresssuccessfulfailedobsolete

notenullable string

audit*AuditDto (object)

project*BasicProjectDto (object)

version*BasicVersionDto (object)

node*BasicNodeDto (object)

id*string

prefix*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "status": "preparing",
    "note": "text",
    "audit": {
      "createdAt": "2024-04-19T13:33:57.589Z",
      "createdBy": "text",
      "updatedAt": "2024-04-19T13:33:57.589Z",
      "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"
  }
]

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

teamSlug*string

Body

application/json

versionId*string

nodeId*string

prefix*string

notenullable string

Response

201400403409

New deployment created.

Body

application/json

status*enum

preparingin-progresssuccessfulfailedobsolete

notenullable string

audit*AuditDto (object)

project*BasicProjectDto (object)

version*BasicVersionDto (object)

node*BasicNodeDto (object)

id*string

prefix*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "versionId": "text",
      "nodeId": "text",
      "prefix": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "preparing",
  "note": "text",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "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"
}

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

teamSlug*string

deploymentId*string

Response

200400403404

Details of a deployment.

Body

application/json

status*enum

preparingin-progresssuccessfulfailedobsolete

notenullable string

audit*AuditDto (object)

project*BasicProjectDto (object)

version*BasicVersionDto (object)

node*BasicNodeDto (object)

id*string

prefix*string

environment*array of UniqueKeyValueDto (object)

publicKeynullable string

instances*array of InstanceDto (object)

lastTry*number

token*DeploymentTokenDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "preparing",
  "note": "text",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "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": "2024-04-19T13:33:57.589Z",
      "image": {
        "id": "text",
        "name": "text",
        "tag": "text",
        "order": 0,
        "config": {
          "expose": "none",
          "restartPolicy": "always",
          "networkMode": "none",
          "deploymentStrategy": "recreate",
          "name": "text",
          "environment": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "secrets": [
            {
              "required": false,
              "id": "text",
              "key": "text"
            }
          ],
          "routing": {
            "domain": "text",
            "path": "text",
            "stripPath": false,
            "uploadLimit": "text"
          },
          "user": 0,
          "tty": false,
          "configContainer": {
            "image": "text",
            "volume": "text",
            "path": "text",
            "keepFiles": false
          },
          "ports": [
            {
              "id": "text",
              "internal": 0,
              "external": 0
            }
          ],
          "portRanges": [
            {
              "id": "text",
              "internal": {
                "from": 0,
                "to": 0
              },
              "external": {
                "from": 0,
                "to": 0
              }
            }
          ],
          "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": false,
              "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": false,
          "useLoadBalancer": false,
          "extraLBAnnotations": [
            {
              "value": "text",
              "id": "text",
              "key": "text"
            }
          ],
          "healthCheckConfig": {
            "port": 0,
            "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": "2024-04-19T13:33:57.589Z",
        "registry": {
          "type": "v2",
          "id": "text",
          "name": "text"
        }
      },
      "config": {
        "expose": "none",
        "restartPolicy": "always",
        "networkMode": "none",
        "deploymentStrategy": "recreate",
        "secrets": [
          {
            "required": false,
            "id": "text",
            "key": "text",
            "value": "text",
            "encrypted": false,
            "publicKey": "text"
          }
        ],
        "name": "text",
        "environment": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "routing": {
          "domain": "text",
          "path": "text",
          "stripPath": false,
          "uploadLimit": "text"
        },
        "user": 0,
        "tty": false,
        "configContainer": {
          "image": "text",
          "volume": "text",
          "path": "text",
          "keepFiles": false
        },
        "ports": [
          {
            "id": "text",
            "internal": 0,
            "external": 0
          }
        ],
        "portRanges": [
          {
            "id": "text",
            "internal": {
              "from": 0,
              "to": 0
            },
            "external": {
              "from": 0,
              "to": 0
            }
          }
        ],
        "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": false,
            "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": false,
        "useLoadBalancer": false,
        "extraLBAnnotations": [
          {
            "value": "text",
            "id": "text",
            "key": "text"
          }
        ],
        "healthCheckConfig": {
          "port": 0,
          "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": 0,
  "token": {
    "id": "text",
    "name": "text",
    "createdAt": "2024-04-19T13:33:57.589Z",
    "expiresAt": "2024-04-19T13:33:57.589Z"
  }
}

Delete deployment.

Request must include teamSlug and deploymentId in the URL.

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

Path parameters

teamSlug*string

deploymentId*string

Response

204403404

Deployment deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update deployment.

Request must include deploymentId and teamSlug in URL.

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

Path parameters

teamSlug*string

deploymentId*string

Body

application/json

notenullable string

prefixnullable string

environmentnullable array of UniqueKeyValueDto (object)

Response

204400403404

Deployment modified.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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

teamSlug*string

deploymentId*string

instanceId*string

Response

200400403404

Details of an instance.

Body

application/json

id*string

updatedAt*string (date-time)

image*ImageDto (object)

confignullable all of

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "updatedAt": "2024-04-19T13:33:57.589Z",
  "image": {
    "id": "text",
    "name": "text",
    "tag": "text",
    "order": 0,
    "config": {
      "expose": "none",
      "restartPolicy": "always",
      "networkMode": "none",
      "deploymentStrategy": "recreate",
      "name": "text",
      "environment": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "secrets": [
        {
          "required": false,
          "id": "text",
          "key": "text"
        }
      ],
      "routing": {
        "domain": "text",
        "path": "text",
        "stripPath": false,
        "uploadLimit": "text"
      },
      "user": 0,
      "tty": false,
      "configContainer": {
        "image": "text",
        "volume": "text",
        "path": "text",
        "keepFiles": false
      },
      "ports": [
        {
          "id": "text",
          "internal": 0,
          "external": 0
        }
      ],
      "portRanges": [
        {
          "id": "text",
          "internal": {
            "from": 0,
            "to": 0
          },
          "external": {
            "from": 0,
            "to": 0
          }
        }
      ],
      "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": false,
          "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": false,
      "useLoadBalancer": false,
      "extraLBAnnotations": [
        {
          "value": "text",
          "id": "text",
          "key": "text"
        }
      ],
      "healthCheckConfig": {
        "port": 0,
        "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": "2024-04-19T13:33:57.589Z",
    "registry": {
      "type": "v2",
      "id": "text",
      "name": "text"
    }
  },
  "config": {
    "expose": "none",
    "restartPolicy": "always",
    "networkMode": "none",
    "deploymentStrategy": "recreate",
    "secrets": [
      {
        "required": false,
        "id": "text",
        "key": "text",
        "value": "text",
        "encrypted": false,
        "publicKey": "text"
      }
    ],
    "name": "text",
    "environment": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "routing": {
      "domain": "text",
      "path": "text",
      "stripPath": false,
      "uploadLimit": "text"
    },
    "user": 0,
    "tty": false,
    "configContainer": {
      "image": "text",
      "volume": "text",
      "path": "text",
      "keepFiles": false
    },
    "ports": [
      {
        "id": "text",
        "internal": 0,
        "external": 0
      }
    ],
    "portRanges": [
      {
        "id": "text",
        "internal": {
          "from": 0,
          "to": 0
        },
        "external": {
          "from": 0,
          "to": 0
        }
      }
    ],
    "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": false,
        "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": false,
    "useLoadBalancer": false,
    "extraLBAnnotations": [
      {
        "value": "text",
        "id": "text",
        "key": "text"
      }
    ],
    "healthCheckConfig": {
      "port": 0,
      "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"
        }
      ]
    }
  }
}

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

teamSlug*string

deploymentId*string

instanceId*string

Body

application/json

config*InstanceContainerConfigDto (object)

Response

204400403404

Instance configuration updated.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "config": {}
    }),
});
const data = await response.json();

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

teamSlug*string

deploymentId*string

instanceId*string

Response

200400403404

Secrets of an instance listed.

Body

application/json

container*ContainerIdentifierDto (object)

publicKey*string

keysnullable array of string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/instances/{instanceId}/secrets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Start the deployment process.

Request must include teamSlug and deploymentId in the URL.

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

Path parameters

teamSlug*string

deploymentId*string

Body

application/json

instancesarray of string

Response

204400403

Deployment initiated.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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

teamSlug*string

deploymentId*string

Body

application/json

nodeId*string

prefix*string

notenullable string

Response

201400403409

Deployment copied.

Body

application/json

status*enum

preparingin-progresssuccessfulfailedobsolete

notenullable string

audit*AuditDto (object)

project*BasicProjectDto (object)

version*BasicVersionDto (object)

node*BasicNodeDto (object)

id*string

prefix*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/copy', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "nodeId": "text",
      "prefix": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "preparing",
  "note": "text",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "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"
}

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

teamSlug*string

deploymentId*string

Query parameters

Response

200400403404

Deployment event log.

Body

application/json

items*array of DeploymentEventDto (object)

total*number

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/log', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "log",
      "deploymentStatus": "preparing",
      "createdAt": "2024-04-19T13:33:57.589Z",
      "log": [
        "text"
      ],
      "containerState": {
        "state": "running",
        "instanceId": "text"
      }
    }
  ],
  "total": 0
}

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

teamSlug*string

deploymentId*string

Body

application/json

name*string

expirationInDaysnumber

Response

200201400403409

Deployment token with jwt and the curl command.

Body

application/json

id*string

name*string

createdAt*string (date-time)

expiresAtnullable string (date-time)

token*string

curl*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/token', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "createdAt": "2024-04-19T13:33:57.589Z",
  "expiresAt": "2024-04-19T13:33:57.589Z",
  "token": "text",
  "curl": "text"
}

Delete deployment token.

Request must include teamSlug and deploymentId in the URL.

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

Path parameters

teamSlug*string

deploymentId*string

Response

204403404

Deployment token deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/deployments/{deploymentId}/token', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

Response

200403

Token list fetched.

Body

application/json

id*string

name*string

expiresAtstring (date-time)

createdAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "expiresAt": "2024-04-19T13:33:57.589Z",
    "createdAt": "2024-04-19T13:33:57.589Z"
  }
]

Create access token.

Request must include name and expirationInDays.

POST/api/tokens

Body

application/json

Token created.

name*string

expirationInDays*number

Response

201400403409

Headers

Body

application/json

id*string

name*string

expiresAtstring (date-time)

createdAt*string (date-time)

token*string

Request

JavaScriptCurl

const response = await fetch('/api/tokens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "expirationInDays": 0
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "expiresAt": "2024-04-19T13:33:57.589Z",
  "createdAt": "2024-04-19T13:33:57.589Z",
  "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

tokenId*string

Response

200400403404

Token details listed.

Body

application/json

id*string

name*string

expiresAtstring (date-time)

createdAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/tokens/{tokenId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "expiresAt": "2024-04-19T13:33:57.589Z",
  "createdAt": "2024-04-19T13:33:57.589Z"
}

Delete an access token.

Request must include tokenId.

DELETE/api/tokens/{tokenId}

Path parameters

tokenId*string

Response

204403404

Delete token.

Request

JavaScriptCurl

const response = await fetch('/api/tokens/{tokenId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

Response

200403

Data of nodes listed.

Body

application/json

type*enum

dockerk8s

statusenum

unreachableconnectedoutdated

descriptionstring

iconstring

addressstring

connectedAtstring (date-time)

versionstring

updatingboolean

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "type": "docker",
    "status": "unreachable",
    "description": "text",
    "icon": "text",
    "address": "text",
    "connectedAt": "2024-04-19T13:33:57.589Z",
    "version": "text",
    "updating": false,
    "id": "text",
    "name": "text"
  }
]

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

teamSlug*string

Body

application/json

name*string

descriptionstring

iconstring

Response

201400403409

New node created.

Body

application/json

type*enum

dockerk8s

statusenum

unreachableconnectedoutdated

descriptionstring

iconstring

addressstring

connectedAtstring (date-time)

versionstring

updatingboolean

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "docker",
  "status": "unreachable",
  "description": "text",
  "icon": "text",
  "address": "text",
  "connectedAt": "2024-04-19T13:33:57.589Z",
  "version": "text",
  "updating": false,
  "id": "text",
  "name": "text"
}

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

teamSlug*string

nodeId*string

Response

200400403404

Data of the node.

Body

application/json

type*enum

dockerk8s

statusenum

unreachableconnectedoutdated

descriptionstring

iconstring

addressstring

connectedAtstring (date-time)

versionstring

updatingboolean

id*string

name*string

hasToken*boolean

installNodeInstallDto (object)

inUse*boolean

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "docker",
  "status": "unreachable",
  "description": "text",
  "icon": "text",
  "address": "text",
  "connectedAt": "2024-04-19T13:33:57.589Z",
  "version": "text",
  "updating": false,
  "id": "text",
  "name": "text",
  "hasToken": false,
  "install": {
    "command": "text",
    "script": "text",
    "expireAt": "2024-04-19T13:33:57.589Z"
  },
  "inUse": false
}

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

teamSlug*string

nodeId*string

Body

application/json

name*string

descriptionstring

iconstring

Response

204400403404409

Node details modified.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Delete node.

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

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

Path parameters

teamSlug*string

nodeId*string

Response

204403404

Node deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

nodeId*string

Response

200400403404

Body

text/plain

string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/script', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Create agent install script.

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

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

Path parameters

teamSlug*string

nodeId*string

Body

application/json

type*enum

dockerk8s

scriptType*enum

shellpowershell

rootPathstring

dagentTraefikDagentTraefikOptionsDto (object)

Response

200201400403

Install script generated.

Body

application/json

command*string

script*string

expireAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/script', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "docker",
      "scriptType": "shell"
    }),
});
const data = await response.json();

Response

{
  "command": "text",
  "script": "text",
  "expireAt": "2024-04-19T13:33:57.589Z"
}

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

teamSlug*string

nodeId*string

Response

204403404

Agent install script deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/script', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

nodeId*string

Response

204403404

Token revoked.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/token', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update the agent.

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

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

Path parameters

nodeId*string

Response

204400403

Node details modified.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/update', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

nodeId*string

Query parameters

Response

200400403404

Paginated list of the audit log.

Body

application/json

items*array of NodeAuditLogDto (object)

total*number

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/audit', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "createdAt": "2024-04-19T13:33:57.589Z",
      "event": "text"
    }
  ],
  "total": 0
}

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

nodeId*string

prefix*string

name*string

Response

204400403

Container started.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}/start', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

nodeId*string

prefix*string

name*string

Response

204400403

Container stopped.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}/stop', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

nodeId*string

prefix*string

name*string

Response

204400403

Container restarted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}/restart', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

nodeId*string

prefix*string

Response

204403404

Containers deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

nodeId*string

prefix*string

name*string

Response

204403404

Container deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/{prefix}/containers/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

nodeId*string

Query parameters

Response

200403

Fetch data of containers running on a node.

Body

application/json

state*enum

runningwaitingexited

id*ContainerIdentifierDto (object)

command*string

createdAt*string (date-time)

reason*string

imageName*string

imageTag*string

ports*array of ContainerPort (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/containers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "state": "running",
    "id": {
      "prefix": "text",
      "name": "text"
    },
    "command": "text",
    "createdAt": "2024-04-19T13:33:57.589Z",
    "reason": "text",
    "imageName": "text",
    "imageTag": "text",
    "ports": [
      {
        "internal": 0,
        "external": 0
      }
    ]
  }
]

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

nodeId*string

name*string

Response

204400403

Container started.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/containers/{name}/start', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

nodeId*string

name*string

Response

204400403

Container stopped.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/containers/{name}/stop', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

nodeId*string

name*string

Response

204400403

Container restarted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/containers/{name}/restart', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

nodeId*string

name*string

Response

204403404

Container deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/nodes/{nodeId}/containers/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

Query parameters

Response

200403

Paginated list of the audit log.

Body

application/json

items*array of AuditLogDto (object)

total*number

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/audit-log', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "actorType": "get",
      "context": "http",
      "method": "get",
      "createdAt": "2024-04-19T13:33:57.589Z",
      "user": {
        "id": "text",
        "email": "text"
      },
      "name": "text",
      "event": "text"
    }
  ],
  "total": 0
}

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

Response

200

Service status.

Body

application/json

status*object

version*string

lastMigrationstring

Request

JavaScriptCurl

const response = await fetch('/api/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

Response

200403

Notifications listed.

Body

application/json

type*enum

discordslackteams

id*string

name*string

url*string

active*boolean

creatorName*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

Body

application/json

type*enum

discordslackteams

enabledEvents*array of enum

name*string

url*string

active*boolean

Response

201400403409

New notification created.

Body

application/json

type*enum

discordslackteams

enabledEvents*array of enum

id*string

name*string

url*string

active*boolean

creatorName*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/notifications', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "discord",
      "enabledEvents": [
        "deployment-created"
      ],
      "name": "text",
      "url": "text",
      "active": false
    }),
});
const data = await response.json();

Response

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

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

teamSlug*string

notificationId*string

Response

200400403404

Details of notification listed.

Body

application/json

type*enum

discordslackteams

enabledEvents*array of enum

id*string

name*string

url*string

active*boolean

creatorName*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/notifications/{notificationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

notificationId*string

Body

application/json

type*enum

discordslackteams

enabledEvents*array of enum

name*string

url*string

active*boolean

Response

200204400403404409

Notification modified.

Body

application/json

type*enum

discordslackteams

enabledEvents*array of enum

id*string

name*string

url*string

active*boolean

creatorName*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/notifications/{notificationId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "discord",
      "enabledEvents": [
        "deployment-created"
      ],
      "name": "text",
      "url": "text",
      "active": false
    }),
});
const data = await response.json();

Response

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

Delete a notification.

Request must include teamSlug and notificationId in URL.

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

Path parameters

teamSlug*string

notificationId*string

Response

204403404

Notification deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/notifications/{notificationId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Send a test message.

Request must include teamSlug and notificationId in URL.

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

Path parameters

teamSlug*string

notificationId*string

Response

204400403

Test message sent.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/notifications/{notificationId}/test', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

Response

200403

Templates listed.

Body

application/json

id*string

name*string

descriptionstring

technologies*array of string

Request

JavaScriptCurl

const response = await fetch('/api/templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

application/json

type*enum

versionlessversioned

id*string

teamSlug*string

name*string

descriptionstring

Response

201400403409

New project created.

Body

application/json

type*enum

versionlessversioned

descriptionnullable string

audit*AuditDto (object)

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "versionless",
      "id": "text",
      "teamSlug": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "versionless",
  "description": "text",
  "audit": {
    "createdAt": "2024-04-19T13:33:57.589Z",
    "createdBy": "text",
    "updatedAt": "2024-04-19T13:33:57.589Z",
    "updatedBy": "text"
  },
  "id": "text",
  "name": "text"
}

Retrieves the picture of the template

Request must include templateId.

GET/api/templates/{templateId}/image

Path parameters

templateId*string

Response

200400403404

Retrieve data of an image of a template.

Request

JavaScriptCurl

const response = await fetch('/api/templates/{templateId}/image', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

teamSlug*string

Response

200403

Dashboard data listed.

Body

application/json

users*number

auditLog*number

projects*number

versions*number

deployments*number

failedDeployments*number

onboarding*OnboardingDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/dashboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

Response

200403

List of storages.

Body

application/json

descriptionstring

iconstring

url*string

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/storages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

Body

application/json

name*string

descriptionstring

iconstring

url*string

accessKeystring

secretKeystring

Response

201400403409

New storage created.

Body

application/json

descriptionstring

iconstring

url*string

id*string

name*string

accessKeystring

secretKeystring

inUse*boolean

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/storages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "url": "text"
    }),
});
const data = await response.json();

Response

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

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

teamSlug*string

Response

200400403404

Name and ID of storage options listed.

Body

application/json

id*string

name*string

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/storages/options', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

storageId*string

Response

200400403404

Storage details.

Body

application/json

descriptionstring

iconstring

url*string

id*string

name*string

accessKeystring

secretKeystring

inUse*boolean

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/storages/{storageId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

teamSlug*string

storageId*string

Body

application/json

name*string

descriptionstring

iconstring

url*string

accessKeystring

secretKeystring

Response

204400403404409

Storage updated.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/storages/{storageId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "url": "text"
    }),
});
const data = await response.json();

Delete a storage from dyrector.io.

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

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

Path parameters

teamSlug*string

storageId*string

Response

204403404

Storage deleted.

Request

JavaScriptCurl

const response = await fetch('/api/{teamSlug}/storages/{storageId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();