GetCompartment

GET {{baseUrl}}/compartments/:compartmentId

Gets the specified compartment's information.

This operation does not return a list of all the resources inside the compartment. There is no single API operation that does that. Compartments can contain multiple types of resources (instances, block storage volumes, etc.). To find out what's in a compartment, you must call the List operation for each resource type and specify the compartment's OCID as a query parameter in the request. For example, call the ListInstances operation in the Cloud Compute Service or the ListVolumes operation in Cloud Block Storage.

HEADERS

KeyDatatypeRequiredDescription
Datestring(Required) Current Date
Authorizationstring(Required) Signature Authentication on Authorization header

RESPONSES

status: OK

{"id":"elit","compartmentId":"proident Lorem","name":"nisi ipsum","description":"elit do ad in","timeCreated":"1972-02-15T10:25:24.856Z","lifecycleState":"CREATING","definedTags":{},"freeformTags":{},"inactiveStatus":70870037,"isAccessible":true}