Get Docker engine list

Prev Next

Available in Classic and VPC

Get the Docker engine list in the SourceBuild build environment.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/env/docker

Request headers

For information about the headers common to all SourceBuild APIs, see SourceBuild request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://sourcebuild.apigw.ntruss.com/api/v1/env/docker' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.docker Array - Docker engine list

docker

The following describes docker.

Field Type Required Description
id Number - Docker engine ID
name String - Docker engine name

Response status codes

For information about the response status codes common to all SourceBuild APIs, see SourceBuild response status codes.

Response example

The response example is as follows:

{
    "result": {
        "docker": [
            {
                "id": 1,
                "name": "Docker:18.09.1"
            }
        ]
    }
}