Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Resources

List Resources

Lists all the resources defined in your schema.

get/v2/schema/{proj_id}/{env_id}/resources

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

include_built_inboolean

Whether to include or exclude built-in resources, default is False

Whether to include or exclude built-in resources, default is False

include_total_countboolean

Include total count in response

Include total count in response

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

searchstring

Text search for the object name or key

Text search for the object name or key

Response

Successful Response

OR

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",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "key": "repository",
      "name": "Repository",
      "urn": "prn:github:scm:repository",
      "description": "a git repository stored on github",
      "actions": {
        "clone": {
          "id": "90e21d70-2b1b-42f0-b492-8fd69c1d79d1"
        },
        "read": {
          "id": "2bc27751-6115-43c0-b68c-928cb46e34bc"
        },
        "push": {
          "id": "e06da336-6e03-41d6-a495-40b0d7537b2a"
        }
      },
      "roles": {
        "maintainer": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "key": "maintainer",
          "name": "Maintainer",
          "description": "the maintainer role can read from the repo and push changes",
          "permissions": [
            "push"
          ],
          "extends": [
            "contributor"
          ],
          "resource": "repo",
          "granted_to": {
            "id": "8c0a5d99-de8d-4102-b363-7d17843156b3",
            "users_with_role": [
              {
                "role": "Admin",
                "on_resource": "organization",
                "linked_by_relation": "owner",
                "role_id": "4f9ad7ab-15bc-4e25-a5a5-57417b341719",
                "resource_id": "17dbf1da-4061-44a6-8f58-55719560f143",
                "relation_id": "534b2d8a-e8be-4039-828f-0607691ca48c"
              }
            ]
          },
          "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-e396c9f7e7dd",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      },
      "relations": {
        "parent": {
          "resource_id": "875e4351-e0f5-437f-8235-39547f4f362d",
          "relation_name": "parent",
          "resource": "parent-resource"
        }
      },
      "attributes": {
        "created": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f11",
          "type": "time",
          "description": "the time (timestamp) the repository was created"
        },
        "private": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f22",
          "type": "bool",
          "description": "whether the repo is private (if false, the repo is public)"
        }
      }
    }
  ]
}