Resource Restrictions

Restrict a resource

Changed on

Mark a resource as restricted. Only space admins or users with the the correct permissions can perform this action. Idempotent.

Payload Requirements

  • resource_id: The global ID for the resource.

Valid examples

{ "resource_id": "TW9kZWw6MTIxOmFCY0Q=" }

{ "resource_id": "RGFzaGJvYXJkOjQ1NjphQmNE" }

Invalid example

{ "resource_id": "Not a valid global ID" }

Returns 400 — only resources with the correct type are accepted

<Note>This endpoint is in beta, read more here.</Note>

post/v2/resource-restrictions

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/resource-restrictions
  • Auth
    HTTP bearer

Request body

resource_idstring required

A universally unique identifier (base64-encoded opaque string).

Example request

{
  "resource_id": "RW50aXR5OjEyMzQ1"
}

Response

A resource restriction record

resource_type'PROJECT' | 'DASHBOARD' | 'PROMPT' required

Type of the restricted resource.

  • PROJECT - A project within a space.
  • DASHBOARD - A dashboard within a space.
  • PROMPT - A prompt within a space.
resource_idstring required

The ID of the restricted resource

created_atstring date-time required

When the restriction was created

Example response

{
  "resource_type": "PROJECT",
  "resource_id": "TW9kZWw6MTIxOmFCY0Q="
}

Changes

  • 5dd5e8f886f9Revision changes
    • warning

      added the new PROMPT enum value to the response property for the response status

  • c972f4a6595cRevision changes
    • warning

      added the new DASHBOARD enum value to the response property for the response status