Update an API scope

View as Markdown
PATCH
/resources/api_resources/{api_id}/scopes/{scope_id}

Applies a partial update to the specified API scope. Only fields included in the request are updated.

Authorization

API-Key
headerX-API-KEY<token>

MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>

Path Parameters

scope_id*string

The unique identifier of the API scope.

api_id*string

The unique identifier of the API resource.

Request Body

application/json

The request payload used to update an API scope.

TypeScript Definitions

Use the request body type in TypeScript.

Patch API Scope Request: Used to update one or more properties of an existing API scope.

Response Body

200

application/json

The API scope was updated successfully

TypeScript Definitions

Use the response body type in TypeScript.

API Scope Response: Represents a permissioned scope that defines the level of access a client may request and that can be embedded into access tokens.

Errors

401Unauthorized
403Forbidden

curl -X PATCH "https://your-domain.us.monocloud.com/api/resources/api_resources/n8TniSuy4WN9ROJYNwir6/scopes/tQi5Nu2sg7TVB727UfHPT" \  -H "X-API-KEY: <token>" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "display_name": null,  "description": null,  "show_in_discovery_document": true,  "creation_time": 0,  "last_updated": 0,  "name": "string",  "required": true,  "emphasize": true,  "is_default": true,  "user_claims": [    "string"  ]}
© 2026 MonoCloud. All rights reserved.