Skip to main content
PATCH
/
v4
/
application-deployments
/
{application_deployment_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const applicationDeployment = await client.applicationDeployments.update('application_deployment_id');

console.log(applicationDeployment.id);
{
  "id": "<string>",
  "name": "<string>",
  "endpoint": "<string>",
  "application_variant_id": "<string>",
  "status": "PENDING",
  "is_active": true,
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
application_deployment_id
string
required

Body

application/json
​
name
string
​
is_active
boolean

Response

Successful Response

​
id
string
required
​
name
string
required
​
endpoint
string
required
​
application_variant_id
string
required
​
status
enum<string>
required

An enum representing the status of an application deployment. Attributes: PENDING: The deployment is pending. READY: The deployment is ready. FAILED: The deployment has failed. STOPPED: The deployment has stopped.

Available options:
PENDING,
READY,
FAILED,
STOPPED
​
is_active
boolean
required
​
account_id
string
required

The ID of the account that owns the given entity.

​
created_by_user_id
string
required

The user who originally created the entity.

​
created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
​
created_at
string<date-time>
required

The date and time when the entity was created in ISO format.