Stop a deployment

POST

/api/v1/deployments/{id}/stop

const url = 'http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stop';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stop \
  --header 'X-API-Key: <X-API-Key>'

Stops a running deployment.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Deployment UUID

Responses

200

Deployment stopped successfully

403

Forbidden — caller lacks required permission

404

Deployment not found