Compose

Compose create

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

name*string

Length1 <= length

description?string|null

environmentId*string

composeType?string

Value in"docker-compose" | "stack"

appName?string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

serverId?string|null

composeFile?string

sourceType?string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.create" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "environmentId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "environmentId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose one

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.one?composeId=string"

curl -X GET "https://your-notploy-instance.com/api/compose.one?composeId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose update

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

name?string

Length1 <= length

appName?string

Match^[a-zA-Z0-9._-]+$

Length1 <= length <= 63

description?string|null

env?string|null

composeFile?string

refreshToken?string|null

sourceType?string

composeType?string

Value in"docker-compose" | "stack"

repository?string|null

owner?string|null

branch?string|null

autoDeploy?boolean|null

gitlabProjectId?number|null

gitlabRepository?string|null

gitlabOwner?string|null

gitlabBranch?string|null

gitlabPathNamespace?string|null

bitbucketRepository?string|null

bitbucketRepositorySlug?string|null

bitbucketOwner?string|null

bitbucketBranch?string|null

giteaRepository?string|null

giteaOwner?string|null

giteaBranch?string|null

customGitUrl?string|null

customGitBranch?string|null

customGitSSHKeyId?string|null

command?string

createEnvFile?boolean

enableSubmodules?boolean

composePath?string

Length1 <= length

suffix?string

randomize?boolean

isolatedDeployment?boolean

isolatedDeploymentsVolume?boolean

pullImages?boolean

triggerType?string|null

composeStatus?string

Value in"idle" | "running" | "done" | "error"

icon?|null

environmentId?string

createdAt?string

watchPaths?|null

githubId?string|null

gitlabId?string|null

bitbucketId?string|null

giteaId?string|null

serviceNetworks?|null

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.update" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.update" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose delete

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

deleteVolumes*boolean

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.delete" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "deleteVolumes": true
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.delete" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string",    "deleteVolumes": true  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose clean Queues

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.cleanQueues" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.cleanQueues" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose kill Build

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.killBuild" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.killBuild" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose load Services

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

composeId*string

Length1 <= length

type?string

Default"cache"

Value in"fetch" | "cache"

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.loadServices?composeId=string"

curl -X GET "https://your-notploy-instance.com/api/compose.loadServices?composeId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose load Mounts By Service

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

composeId*string

Length1 <= length

serviceName*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.loadMountsByService?composeId=string&serviceName=string"

curl -X GET "https://your-notploy-instance.com/api/compose.loadMountsByService?composeId=string&serviceName=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose fetch Source Type

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.fetchSourceType" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.fetchSourceType" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose randomize Compose

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

suffix?string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.randomizeCompose" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.randomizeCompose" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose isolated Deployment

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

suffix?string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.isolatedDeployment" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.isolatedDeployment" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose get Converted Compose

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.getConvertedCompose?composeId=string"

curl -X GET "https://your-notploy-instance.com/api/compose.getConvertedCompose?composeId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose deploy

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

title?string

description?string

freshVolumes?boolean

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.deploy" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.deploy" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose redeploy

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

title?string

description?string

freshVolumes?boolean

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.redeploy" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.redeploy" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose stop

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.stop" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.stop" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose start

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.start" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.start" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose get Default Command

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.getDefaultCommand?composeId=string"

curl -X GET "https://your-notploy-instance.com/api/compose.getDefaultCommand?composeId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose refresh Token

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.refreshToken" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.refreshToken" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose deploy Template

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

environmentId*string

serverId?string

id*string

baseUrl?string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.deployTemplate" \
  -H "Content-Type: application/json" \
  -d '{
    "environmentId": "string",
    "id": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.deployTemplate" \  -H "Content-Type: application/json" \  -d '{    "environmentId": "string",    "id": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose templates

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

baseUrl?string

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.templates"

curl -X GET "https://your-notploy-instance.com/api/compose.templates"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose get Tags

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

baseUrl?string

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/compose.getTags"

curl -X GET "https://your-notploy-instance.com/api/compose.getTags"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose disconnect Git Provider

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.disconnectGitProvider" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.disconnectGitProvider" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose move

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

targetEnvironmentId*string

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.move" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string",
    "targetEnvironmentId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.move" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string",    "targetEnvironmentId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose process Template

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

base64*string

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.processTemplate" \
  -H "Content-Type: application/json" \
  -d '{
    "base64": "string",
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.processTemplate" \  -H "Content-Type: application/json" \  -d '{    "base64": "string",    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose import

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

base64*string

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.import" \
  -H "Content-Type: application/json" \
  -d '{
    "base64": "string",
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.import" \  -H "Content-Type: application/json" \  -d '{    "base64": "string",    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Compose cancel Deployment

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

composeId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/compose.cancelDeployment" \
  -H "Content-Type: application/json" \
  -d '{
    "composeId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/compose.cancelDeployment" \  -H "Content-Type: application/json" \  -d '{    "composeId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`