OrchestrationObjects REST Endpoints

OrchestrationObjects
An orchestration object is an object in Compute Classic which is managed by orchestration v2. It is the primary building block of an orchestration. Each object contains all the attributes for the compute, networking, or storage resource that you want to create. When you define an object in an orchestration, you can create dependencies with other objects by using references. See Object References and Relationships in Using Oracle Cloud Infrastructure Compute Classic.

Orchestrations are designed to handle up to 100 interdependent objects. Creating objects using other APIs may compromise your orchestration.

Note: You should always use your orchestrations to manage resources that you've reated using orchestrations. For example, use the OrchestrationObject API to add a security list to a running instance or to create a storage snapshot of an attached storage volume instead of using the SecLists or StorageSnapshots APIs respectively. Don't, for example, use the web console or the REST API to delete an object that you created using an orchestration. This could cause your orchestration to either attempt to re-create the object and associated resources, or to go into an error state.

Also remember that you shouldn't try to use or manage resources created using orchestrations v1 by referencing them in orchestrations v2, or vice versa.

You can add objects to, remove objects from, or update objects in an orchestration by using the HTTP requests listed below.

Create an Orchestration Object
Method: post
Path: /platform/v1/object/
Delete an Orchestration Object
Method: delete
Path: /platform/v1/object/{name}
Retrieve Details of all Orchestration Objects in a Container
Method: get
Path: /platform/v1/object/{container}/
Retrieve Details of an Orchestration Object
Method: get
Path: /platform/v1/object/{name}
Retrieve Names of all Orchestration Objects and Subcontainers in a Container
Method: get
Path: /platform/v1/object/{container}
Retrieve Names of Containers
Method: get
Path: /platform/v1/object/
Update an Orchestration Object
Method: put
Path: /platform/v1/object/{name}