StediDOCS
This product is in Developer Preview

Formation

Formation: Customer resource management
Authorization - API Key generated in Stedi terminal

Download OpenAPI

Create template

POST/templates
Create a new template.
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.
Request body

application/json

Optionalobject
Parameters to be passed to the deployment.
Requiredulid
The identifier of an uploaded template.
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 -.

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.
Optionalquery

The value of next_page_token returned in prior request (used for pagination).

Optionalquery
Limit response to resource sets with the given status.

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.

For example, Stedi::Example
Optionalquery

Limit response to resource sets containing the specified resource primary identifier. Must also specify a resource_type.

For example, 01FFSY6ZJ9SPNRFRJNY6DCREFX

Example

GET
https://formation.stedi.com/2021-08-10/resource_sets?page_size=5&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 identifier for a given template. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$

Example

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

Read resource set

GET/resource_sets/{id}
Retrieve an existing resource set and its resources.
Parameters
Requiredpath
The identifier for a given resource_set. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$

Example

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

Delete resource set

DELETE/resource_sets/{id}

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

Parameters
Requiredpath
The identifier for a given resource_set. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
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/01FT58ZVFHF8A188NGR8E8W5BX

Generate template

POST/generated_templates
Generate a new Formation template from Stedi resources.
Request body

application/json

Requiredstring
The identifier of the resource to create a template for.
Requiredstring
Optionalstring
The type of the resource to create a template for.

Possible values

yaml json

Optionalstring
The property of the resource to match identifier with.

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.

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.

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. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
Optionalquery
Limit response to this number of items.
Optionalquery

The value of next_page_token returned in prior request (used for pagination).

Optionalquery
A cursor for use in pagination that defines your place in the list.

Example

GET
https://formation.stedi.com/2021-08-10/resource_sets/01FT58ZVFJZMVW1MM9RKNXD4B4/events?page_size=14&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&since_event_id=caf310f6-b5d2-4c60-8cd4-f22be5db5a79

List deployment events

GET/deployments/{deployment_id}/events
Retrieve a list containing every event for a deployment.
Parameters
Requiredpath
Identifier of the deployment. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
Optionalquery
Limit response to this number of items.
Optionalquery

The value of next_page_token returned in prior request (used for pagination).

Optionalquery
A cursor for use in pagination that defines your place in the list.

Example

GET
https://formation.stedi.com/2021-08-10/deployments/01FT58ZVFJ8KQ7NVK4ANWWFVMS/events?page_size=7&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&since_event_id=3214637e-19c5-46d4-958f-06458c617ede

Cancel deployment

DELETE/resource_sets/{id}/deployments/{deployment_id}
Cancel deployment
Parameters
Requiredpath
Identifier of the resource set. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$
Requiredpath
Identifier of the deployment. Pattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$

Example

DELETE
https://formation.stedi.com/2021-08-10/resource_sets/01FT58ZVFJQD6ZXW2FJ3XAZFQV/deployments/01FT58ZVFZTKQ2F8HYYG1VRSVN

List managed resources

GET/managed_resources/{resource_type}/{resource_id}
Retrieve a list containing every managed resources
Parameters
Requiredpath
The resource type to list For example, Stedi::Example
Optionalpath
The identifier property for a specific resource For example, 01FFSY6ZJ9SPNRFRJNY6DCREFX
Optionalquery
Limit response to this number of managed_resources.
Optionalquery

The value of next_page_token returned in prior request (used for pagination).

Example

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