StediDOCS
GuidesAPI Reference
This product is in Developer Preview

Formation

Formation: Customer resource management

Authorization - API Key generated in Stedi terminal

Create template

POST/templates

Create a new template.

Parameters

No parameters

Request body

application/json

Requiredobject

Example

POST
https://formation.stedi.com/2021-08-10/templates

Create deployment

POST/deployments

Send a command to apply a template to a resource set.

Parameters

No parameters

Request body

application/json

Optionalobject
Parameters to be passed to the deployment.
Requiredulid
The identifier of an uploaded template. The value must be a string.
Optionalarray
A list of logical resource identifiers that should be retained on delete. The values must be strings
Array of string objects.
Requiredstring

The name of a resource set. Allowed characters are alphanumeric, _, or -. The value must be a string.

Optionalobject
Reserved for future use.
Optionalboolean
If true, all updates will be performed regardless of whether the template was changed.

Example

POST
https://formation.stedi.com/2021-08-10/deployments

List resource sets

GET/resource_sets

Retrieve a list containing every resource set for current organization.

Parameters
Optionalquery
Limit response to this number of items. The value can range between 1 and 50, the default is 25.
Optionalquery

The value of next_page_token returned in prior request (used for pagination). The value must be a string.

Optionalquery
Limit response to resource sets with the given status. The value must be a string.

Possible values

queued in_progress complete failed deleted

Optionalquery

Limit response to resource sets containing the specified resource type. Must also specify a resource_id. The value must be a string.

For example, Stedi::Example
Optionalquery

Limit response to resource sets containing the specified resource primary identifier. Must also specify a resource_type. The value must be a string.

For example, 01FFSY6ZJ9SPNRFRJNY6DCREFX

Example

GET
https://formation.stedi.com/2021-08-10/resource_sets?page_size=1&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&status=queued&resource_type=Stedi::Example&resource_id=01FFSY6ZJ9SPNRFRJNY6DCREFX

Read template

GET/templates/{id}

Retrieve an existing template.

Parameters
Requiredpath
The id for a given template The value must be a string. Pattern: ^[A-Za-z0-9_-]+$

Example

GET
https://formation.stedi.com/2021-08-10/templates/y8PZPr

Read resource set

GET/resource_sets/{id}

Retrieve an existing resource set and its resources.

Parameters
Requiredpath
The id for a given resource_set The value must be a string. Pattern: ^[A-Za-z0-9_-]+$

Example

GET
https://formation.stedi.com/2021-08-10/resource_sets/ez

Delete resource set

DELETE/resource_sets/{id}

Delete an existing resource set and mark the resource status as delete_in_progress.

Parameters
Requiredpath
The id for a given resource_set The value must be a string. The value must be a string. Pattern: ^[A-Za-z0-9_-]+$
Request body

application/json

Optionalarray
A list of logical resource identifiers that should be retained on delete. The values must be strings
Array of string objects.

Example

DELETE
https://formation.stedi.com/2021-08-10/resource_sets/3FpH6

Generate template

POST/generated_templates

Generate a new Formation template from Stedi resources.

Parameters

No parameters

Request body

application/json

Requiredstring
The identifier of the resource to create a template for. The value must be a string.
Requiredstring
The value must be a string.
Optionalstring
The type of the resource to create a template for. The value must be a string.

Possible values

yaml json

Optionalstring
The property of the resource to match identifier with. The value must be a string.

Example

POST
https://formation.stedi.com/2021-08-10/generated_templates

Read resource set by name

GET/resource_sets/name/{name}

Retrieve a resource set based on its name.

Parameters
Requiredpath
Name of resource set. The value must be a string.

Example

GET
https://formation.stedi.com/2021-08-10/resource_sets/name/...

Delete resource set by name

DELETE/resource_sets/name/{name}

Delete a resource set based on its name.

Parameters
Requiredpath
Name of resource set. The value must be a string. The value must be a string.

Example

DELETE
https://formation.stedi.com/2021-08-10/resource_sets/name/...

List deployment events for resource set

GET/resource_sets/{id}/events

Retrieve a list containing every deployment event for a resource set.

Parameters
Requiredpath
Identifier of the resource set. The value must be a string. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
Optionalquery
Limit response to this number of items. The value can range between 1 and 50, the default is 25.
Optionalquery

The value of next_page_token returned in prior request (used for pagination). The value must be a string.

Optionalquery
A cursor for use in pagination that defines your place in the list. The value must be a string.

Example

GET
https://formation.stedi.com/2021-08-10/resource_sets/01FGF88XR284ATE8TEES0GM05W/events?page_size=43&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&since_event_id=003b93e9-aa25-4d30-98d0-08f9b5d54103

List deployment events

GET/deployments/{deployment_id}/events

Retrieve a list containing every event for a deployment.

Parameters
Requiredpath
Identifier of the deployment. The value must be a string. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
Optionalquery
Limit response to this number of items. The value can range between 1 and 50, the default is 25.
Optionalquery

The value of next_page_token returned in prior request (used for pagination). The value must be a string.

Optionalquery
A cursor for use in pagination that defines your place in the list. The value must be a string.

Example

GET
https://formation.stedi.com/2021-08-10/deployments/01FGF88XR3RTZNCK45NE9WBD39/events?page_size=36&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&since_event_id=269b16bf-ed81-46e3-be41-ae1f83d6a547

Cancel deployment

DELETE/resource_sets/{id}/deployments/{deployment_id}

Cancel deployment

Parameters
Requiredpath
Identifier of the resource set. The value must be a string. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
Requiredpath
Identifier of the deployment. The value must be a string. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$

Example

DELETE
https://formation.stedi.com/2021-08-10/resource_sets/01FGF88XPDK7MRM7VP1N71XNF3/deployments/01FGF88XPDMK5914ST60QB6Q87

List managed resources

GET/managed_resources/{resource_type}/{resource_id}

Retrieve a list containing every managed resources

Parameters
Requiredpath
The resource type to list The value must be a string. For example, Stedi::Example
Optionalpath
The identifier property for a specific resource The value must be a string. For example, 01FFSY6ZJ9SPNRFRJNY6DCREFX
Optionalquery
Limit response to this number of managed_resources. The value can range between 1 and 50, the default is 25.
Optionalquery

The value of next_page_token returned in prior request (used for paging). The value must be a string.

Example

GET
https://formation.stedi.com/2021-08-10/managed_resources/Stedi::Example/01FFSY6ZJ9SPNRFRJNY6DCREFX?page_size=29&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...