Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceAccount and accessRoles

Delete a custom role

Deletes one of the organization's custom roles and returns 204. A role still held by a member or service account is refused with 409 ROLE_IN_USE. Requires a signed-in session.

Required permission

Requires the role.manage permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl roles delete <role-id>
DELETE
/v1/roles/{roleId}

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

roleId*string

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/roles/string'
Example Response
Empty

Update a custom role PATCH

Changes a custom role's name, description, permissions, or its model, endpoint and network conditions, and returns it. Built-in roles cannot be changed. Requires a signed-in session. The same no-escalation rule as creation applies.

Overview

Organization-owned identities with a role, for keys that should outlive the people who created them. Deleting an account revokes its keys. Available to organizations with permissions enabled; otherwise these endpoints return 404.