Scale API

Application Specs

application_specs

Methods

Create Application Spec ->
ApplicationSpec
post/v4/application-specs

Description

Creates a application spec

Details

This API can be used to create a application spec. To use this API, review the request schema and pass in all fields that are required to create a application spec.

Delete Application Spec ->
GenericDeleteResponse
delete/v4/application-specs/{application_spec_id}

Description

Deletes a application spec

Details

This API can be used to delete a application spec by ID. To use this API, pass in the id that was returned from your Create Application Spec API call as a path parameter.

List Application Specs -> PageResponse<
ApplicationSpec
>
get/v4/application-specs

Description

Lists all application specs accessible to the user.

Details

This API can be used to list application specs. If a user has access to multiple accounts, all application specs from all accounts the user is associated with will be returned.

Get Application Spec ->
ApplicationSpec
get/v4/application-specs/{application_spec_id}

Description

Gets the details of a application spec

Details

This API can be used to get information about a single application spec by ID. To use this API, pass in the id that was returned from your Create Application Spec API call as a path parameter.

Review the response schema to see the fields that will be returned.

Update Application Spec ->
ApplicationSpec
patch/v4/application-specs/{application_spec_id}

Description

Updates a application spec

Details

This API can be used to update the application spec that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Application Spec API call as a path parameter.

Review the request schema to see the fields that can be updated.

Domain types

ApplicationSpec = { id, account_id, created_at, 6 more... }
PaginatedApplicationSpecs = { current_page, items, items_per_page, 1 more... }