Dokploy

docker

GET/docker.getContainers

docker-getContainers

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/docker.getContainers"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getConfig

docker-getConfig

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

containerId
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/docker.getConfig?containerId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getContainersByAppNameMatch

docker-getContainersByAppNameMatch

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

appTypeAny properties in string, string

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/docker.getContainersByAppNameMatch?appType=stack&appName=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/docker.getContainersByAppLabel

docker-getContainersByAppLabel

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

appName
Required
string

Minimum length: 1
Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/docker.getContainersByAppLabel?appName=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Previous

destination

Next

domain

On this page

docker-getContainersAuthorizationdocker-getConfigAuthorizationQuery Parametersdocker-getContainersByAppNameMatchAuthorizationQuery Parametersdocker-getContainersByAppLabelAuthorizationQuery Parameters