Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Resource Action Groups

Create Resource Action Group

Creates a new action group that can affect the resource.

post/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/action_groups

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

Request body

keystring required

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

namestring required

The name of the action group

descriptionstring

An optional longer description of what this action group represents in your system

attributesobject

optional dictionary of key-value pairs that can be used to store arbitrary metadata about this action group. This metadata can be used to filter action groups using query parameters with attr_ prefix

actionsstring[]

Example request

{
  "key": "writer",
  "name": "Writer",
  "actions": [
    "read",
    "update"
  ],
  "description": "Writer Action Group"
}

Response

Successful Response

namestring required

The name of the action group

descriptionstring

An optional longer description of what this action group represents in your system

attributesobject

optional dictionary of key-value pairs that can be used to store arbitrary metadata about this action group. This metadata can be used to filter action groups using query parameters with attr_ prefix

actionsstring[]
keystring required

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

idstring uuid required

Unique id of the action group

organization_idstring uuid required

Unique id of the organization that the action group belongs to.

project_idstring uuid required

Unique id of the project that the action group belongs to.

environment_idstring uuid required

Unique id of the environment that the action group belongs to.

resource_idstring uuid required

Unique id of the resource that the action group belongs to.

created_atstring date-time required

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

updated_atstring date-time required

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

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "writer",
  "name": "Writer",
  "actions": [
    "read",
    "update"
  ],
  "description": "Writer Action Group",
  "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"
}