Services

Returns the services in an organization that the authenticated user has access to. A service groups stacks, ESC environments, and other resources under shared metadata so its members can discover and access them together. Results are paginated; use continuationToken and maxResults to page through services.

Request Parameters

• orgName string path required
  The organization name
• continuationToken string query optional
  Token from a previous response to fetch the next page of services
• maxResults integer query optional
  Maximum number of services to return per page (max 1000)

Responses

Creates a new service in an organization. A service is a Pulumi Cloud construct that groups stacks, ESC environments, and other resources under shared metadata, making it easier for its members to discover and access the resources that make up a piece of software. The service is owned by a user or a team, and the name must be unique among services owned by the same owner.

Request Parameters

• orgName string path required
  The organization name

Request Body

Responses

Returns the details of a specific service, including its name, owner, description, members, and the stacks, environments, and other items it groups together. A service is identified by its owner type, owner name, and service name. The returned items list is paginated; use continuationToken and maxResults to page through items.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• continuationToken string query optional
  Token from a previous response to fetch the next page of items
• maxResults integer query optional
  Maximum number of items to return per page (max 1000)

Responses

Updates the metadata of an existing service, such as its name, description, and properties. Use AddServiceItemsV2 / RemoveServiceItemV2 to change which stacks, environments, and other items belong to the service.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Request Body

Responses

Deletes a service from an organization. This removes the service’s grouping of stacks, environments, and other resources along with its metadata; it does not delete the underlying stacks or environments themselves. If the service has members besides its owner, deletion requires explicit confirmation via the force parameter.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• force boolean query optional
  Force deletion even if the service has other members

Responses

Checks whether a service exists in the organization without returning its full details. Returns 204 No Content if the service exists, or an error if not found. This is a lightweight check useful for validating service references.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Responses

Adds items, such as stacks or ESC environments, to an existing service. A service is a Pulumi Cloud construct that groups stacks, environments, and other resources under shared metadata so members of the service can discover and access them together. Returns the updated service details with the first page of items; if continuationToken is set on the response, pass it to GetService to fetch the remaining pages.

Prefer AddServiceItemsV2, then GetService to read the items.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• maxResults integer query optional
  Maximum number of items to return on the first page (max 1000)

Request Body

Responses

Removes a specific item (such as a stack or ESC environment) from a service. This only removes the item’s association with the service; it does not delete the underlying resource. Returns the updated service details after the item has been removed, with the first page of items; if continuationToken is set on the response, pass it to GetService to fetch the remaining pages.

Prefer RemoveServiceItemV2, then GetService to read the items.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• itemType string path required
  The item type
• itemName string path required
  The item name
• maxResults integer query optional
  Maximum number of items to return on the first page (max 1000)

Responses

Adds items, such as stacks or ESC environments, to an existing service. A service is a Pulumi Cloud construct that groups stacks, environments, and other resources under shared metadata so members of the service can discover and access them together. Call GetService to read the items list.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name

Request Body

Responses

Removes a specific item (such as a stack or ESC environment) from a service. This only removes the item’s association with the service; it does not delete the underlying resource. Removing an item that is not in the service succeeds with no effect. Call GetService to read the updated items list.

Request Parameters

• orgName string path required
  The organization name
• ownerType string path required
  The owner type
• ownerName string path required
  The owner name
• serviceName string path required
  The service name
• itemType string path required
  The item type
• itemName string path required
  The item name

Responses