Skip to main content
GET
/
resources
/
rbac
/
api-key-permissions
List API key permissions
curl --request GET \
  --url https://api.sevalla.com/v3/resources/rbac/api-key-permissions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
    "name": "app:read",
    "description": "View applications",
    "resource": "APP",
    "action": "READ"
  }
]

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Response

List of available API key permissions

​
id
string<uuid>
required

Unique identifier for the permission

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
name
string
required

Name of the permission

Example:

"app:read"

​
description
string
required

Human-readable description of what this permission allows

Example:

"View applications"

​
resource
enum<string>
required

Resource type this permission applies to. APP - applications. PIPELINE - pipelines. DATABASE - databases. STATIC_SITE - static sites. LOAD_BALANCER - load balancers. OBJECT_STORAGE - object storage. BILLING - billing. COMPANY - company settings. PROJECT - projects. WEBHOOK - webhooks. API_KEY - API keys. REGISTRY_CREDENTIAL - Docker registry credentials.

Available options:
APP,
PIPELINE,
DATABASE,
STATIC_SITE,
LOAD_BALANCER,
OBJECT_STORAGE,
BILLING,
COMPANY,
PROJECT,
WEBHOOK,
API_KEY,
REGISTRY_CREDENTIAL
Example:

"APP"

​
action
enum<string>
required

Action this permission allows on the resource. CREATE - create new resources. READ - view resources. UPDATE - modify resources. DELETE - remove resources.

Available options:
CREATE,
READ,
UPDATE,
DELETE
Example:

"READ"