Skip to content

List Scope Catalog

GET
/api-keys/scopes

The scope vocabulary a key may be granted, so an automation can decide what to ask for without reading source. Read-only, org-independent.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
default_scopes
required
Array<string>
full_access_scopes

The full-access preset: every grantable scope except the explicit-only strict ones. default_scopes is read-only, so this is what a creator picks to opt in to write/run/launch/delete.

Array<string>
read_only_scopes

The read-only preset: every ‘:read’ scope in the grantable vocabulary. Minting a key with exactly these produces a credential that can look but never write, run, launch or delete — the ‘read-only key’ standard option (issue #21188).

Array<string>
resources
required
Array<object>
object
resource
required
string
scopes
required
Array<object>
object
action
required
string
default
required
boolean
scope
required
string
strict
required
boolean
total
required
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string