import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const applicationDeployment of client.applicationDeployments.list()) {
console.log(applicationDeployment.id);
}{
"items": [
{
"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"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Lists all application deployments accessible to the user.
This API can be used to list application deployments. If a user has access to multiple accounts, all application deployments from all accounts the user is associated with will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const applicationDeployment of client.applicationDeployments.list()) {
console.log(applicationDeployment.id);
}{
"items": [
{
"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"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000Successful Response
The data returned for the current page.
Show child attributes
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.
PENDING, READY, FAILED, STOPPED The ID of the account that owns the given entity.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account The date and time when the entity was created in ISO format.
The total number of items of the query
The current page number.
The number of items per page.