Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
ActiveResource

List Active Resources provisioned in an environment.

get/orgs/{orgId}/apps/{appId}/envs/{envId}/resources

Path parameters

orgIdstring required

The Organization ID.

appIdstring required

The Application ID.

envIdstring required

The Environment ID.

Query parameters

scheduled_deletionboolean

If set to true or false, filters resources scheduled or not scheduled for deletion correspondingly.

Response

A possibly empty list of Active Resources.

app_idstring required

The ID of the App the resource is associated with.

classstring required

The Resource Class of the resource

criteria_idstring

The Matching Criteria ID.

def_idstring required

The Resource Definition that this resource was provisioned from.

def_version_idstring required

The Resource Definition Version that this resource was provisioned from.

target_def_version_idstring

The Resource Definition Version pinned to this resource to be provisioned from.

deploy_idstring required

The deployment that the resource was last provisioned in.

driver_accountstring

(Optional) Security account required by the driver.

driver_typestring required

The driver to be used to create the resource.

env_idstring required

The ID of the Environment the resource is associated with.

env_typestring required

The Environment Type of the Environment specified by env_id.

gu_res_idstring required

Globally unique resource id

org_idstring required

the ID of the Organization the Active Resource is associated with.

res_idstring required

The ID of the resource

resourceobject required

The resource provisioning outputs ('values' only).

scheduled_deletionboolean required

Deletion is scheduled for this resource.

secret_refsobject required

Secret references from the resource provisioning output.

statusstring required

Current resource status: 'pending', 'active', or 'deleting'.

typestring required

The Resource Type of the resource

updated_atstring date-time required

The time the resource was last provisioned as part of a deployment.

Example response

[
  {
    "app_id": "test-app",
    "class": "default",
    "def_id": "gcp-dev-postgres",
    "def_version_id": "01234567-89ab-cdef-0123-4567890abcdef",
    "deploy_id": "172a1013b",
    "env_id": "gcp-dev",
    "env_type": "development",
    "gu_res_id": "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
    "org_id": "test-org",
    "res_id": "modules.my-module.externals.my-db",
    "resource": {
      "host": "127.0.0.1",
      "name": "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
      "port": 5432
    },
    "secret_refs": {
      "credentials": "orgs/test-org/resources/7bd3966c9ff8eaa66c5cce855c03d715857c3440/secrets/.credentials"
    },
    "type": "postgres",
    "updated_at": "2020-06-23T16:53:12Z"
  }
]