PEpermit
Resource Instances

List Resource Instances Detailed

Changed on

Lists all the resource instances defined within an environment.

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

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

proj_idstring required

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").

Query parameters

tenantstring

The tenant key or id to filter by

resourcestring

The resource key or id to filter by

searchstring[]

The resource instance key or id to filter by, matched exactly (supports multi-value like this url?search=key-1&search=key-2). Split larger key sets into successive requests of at most 100 values each.

pageinteger

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

per_pageinteger

The number of results per page (max 100).

Response

Successful Response

total_countinteger required
page_countinteger

Example response

{
  "data": [
    {
      "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",
      "relationships": [],
      "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"
      }
    }
  ]
}

Changes