Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Resource Instances

List Resource Instances

Lists all the resource instances defined within an environment.

get/v2/facts/{proj_id}/{env_id}/resource_instances

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Query parameters

tenantstring

The tenant key or id to filter by

The tenant key or id to filter by

resourcestring

The resource key or id to filter by

The resource key or id to filter by

searchstring[]

The resource instance key or id to filter by (supports multi-value like this url?search=key-1&search=key-2)

The resource instance key or id to filter by (supports multi-value like this url?search=key-1&search=key-2)

detailedboolean

If true, will return the relationships of the resource instance.

If true, will return the relationships of the resource instance.

include_total_countboolean

Include total count in response(will make the request slower)

Include total count in response(will make the request slower)

pageinteger

Page number of the results to fetch, starting at 1.

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

The number of results per page (max 100).

Response

Successful Response

OR

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
    "resource_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c5",
    "tenant_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c3",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "key": "react",
    "resource": "repository",
    "tenant": "default",
    "attributes": {
      "private": "false",
      "owner": "facebook"
    }
  }
]