Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Resource Attributes

List Resource Attributes

Lists all the attributes defined on the resource.

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

Path parameters

resource_idstring required

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

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

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

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

type'bool' | 'number' | 'string' | 'time' | 'array' | 'json' | 'object' | 'object_array' required

supported attribute primitives

descriptionstring

An optional longer description of what this attribute respresents in your system

keystring required

A URL-friendly name of the attribute (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the attribute.

idstring uuid required

Unique id of the attribute

resource_idstring uuid required

Unique id of the resource that the attribute belongs to.

resource_keystring required

A URL-friendly name of the resource (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the resource.

organization_idstring uuid required

Unique id of the organization that the attribute belongs to.

project_idstring uuid required

Unique id of the project that the attribute belongs to.

environment_idstring uuid required

Unique id of the environment that the attribute belongs to.

created_atstring date-time required

Date and time when the attribute was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the attribute was last updated/modified (ISO_8601 format).

built_inboolean required

Whether the attribute is built-in, and managed by the Permit system.

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "private",
    "type": "bool",
    "description": "whether or not the github repository is private",
    "resource_id": "40ef0e48-a11f-4963-a229-e396c9f7e7dd",
    "resource_key": "repository",
    "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",
    "built_in": false
  }
]