Space Scopes

List Space Scopes

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · int32OptionalDefault: 100

namestring · nullableOptional

Filter space scopes by name. Supports wildcard () for partial matches - use * for contains, prefix for starts with, *suffix for ends with

page_tokenstring · nullableOptional

Responses

200

OK

application/json

get

/api/admin/v1/space-scopes

HTTPcURLJavaScriptPython

GET /api/admin/v1/space-scopes HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "query": "text",
      "created_date": "text",
      "updated_date": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Space Scope

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Display name for this space scope (must be unique per account)

querystringRequired

AQL (Apono Query Language) expression that filters which resources belong to this scope

Responses

200

OK

application/json

A space scope defines which resources are visible within a space using an AQL (Apono Query Language) expression. When multiple scopes are assigned to a space, their results are combined (OR logic).

idstringRequired

Unique identifier of the space scope

namestringRequired

Display name of the space scope (unique per account)

querystringRequired

AQL (Apono Query Language) expression that filters which resources belong to this scope.

created_datestring · date-timeRequired

ISO 8601 formatted date-time

updated_datestring · date-timeRequired

ISO 8601 formatted date-time

post

/api/admin/v1/space-scopes

HTTPcURLJavaScriptPython

POST /api/admin/v1/space-scopes HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "query": "text"
}

200

OK

{
  "id": "text",
  "name": "text",
  "query": "text",
  "created_date": "text",
  "updated_date": "text"
}

Get Space Scope

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier or display name of the space scope

Responses

200

OK

application/json

A space scope defines which resources are visible within a space using an AQL (Apono Query Language) expression. When multiple scopes are assigned to a space, their results are combined (OR logic).

idstringRequired

Unique identifier of the space scope

namestringRequired

Display name of the space scope (unique per account)

querystringRequired

AQL (Apono Query Language) expression that filters which resources belong to this scope.

created_datestring · date-timeRequired

ISO 8601 formatted date-time

updated_datestring · date-timeRequired

ISO 8601 formatted date-time

get

/api/admin/v1/space-scopes/{id}

HTTPcURLJavaScriptPython

GET /api/admin/v1/space-scopes/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "text",
  "name": "text",
  "query": "text",
  "created_date": "text",
  "updated_date": "text"
}

Update Space Scope

put

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier or display name of the space scope

Body

application/json

namestringRequired

Display name for this space scope (must be unique per account)

querystringRequired

AQL (Apono Query Language) expression that filters which resources belong to this scope

Responses

200

OK

application/json

A space scope defines which resources are visible within a space using an AQL (Apono Query Language) expression. When multiple scopes are assigned to a space, their results are combined (OR logic).

idstringRequired

Unique identifier of the space scope

namestringRequired

Display name of the space scope (unique per account)

querystringRequired

AQL (Apono Query Language) expression that filters which resources belong to this scope.

created_datestring · date-timeRequired

ISO 8601 formatted date-time

updated_datestring · date-timeRequired

ISO 8601 formatted date-time

put

/api/admin/v1/space-scopes/{id}

HTTPcURLJavaScriptPython

PUT /api/admin/v1/space-scopes/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "query": "text"
}

200

OK

{
  "id": "text",
  "name": "text",
  "query": "text",
  "created_date": "text",
  "updated_date": "text"
}

Delete Space Scope

delete

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier or display name of the space scope

Responses

204

No Content

delete

/api/admin/v1/space-scopes/{id}

HTTPcURLJavaScriptPython

DELETE /api/admin/v1/space-scopes/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content