Update engine | API Reference | Descope Documentation

POST

/v1/mgmt/engine/update

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

id?string

name?string

Update an existing engine, using a valid management key.

curl -X POST "https://api.descope.com/v1/mgmt/engine/update" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.descope.com/v1/mgmt/engine/update" \  -H "Content-Type: application/json" \  -d '{}'

ResponseOK

{
  "engine": {
    "id": "string",
    "name": "string",
    "secret": "string",
    "createdTime": 0
  }
}

{  "engine": {    "id": "string",    "name": "string",    "secret": "string",    "createdTime": 0  }}

TypeScript

export interface Response {
/**
 * Engine is the management-facing representation of an engine. It deliberately
 *  exposes only externally relevant fields; EngineService internal fields (row
 *  version, projectId, last-sync time, reported image/content versions) are omitted.
 */
engine?: {
id?: string
name?: string
/**
 * secret is populated only in CreateEngine and RotateEngineSecret responses;
 *  it is always empty in LoadEngine / LoadEngines responses.
 */
secret?: string
/**
 * createdTime is epoch seconds (int32 so it serializes as a JSON number).
 */
createdTime?: number
}
}

export interface Response {/** * Engine is the management-facing representation of an engine. It deliberately *  exposes only externally relevant fields; EngineService internal fields (row *  version, projectId, last-sync time, reported image/content versions) are omitted. */engine?: {id?: stringname?: string/** * secret is populated only in CreateEngine and RotateEngineSecret responses; *  it is always empty in LoadEngine / LoadEngines responses. */secret?: string/** * createdTime is epoch seconds (int32 so it serializes as a JSON number). */createdTime?: number}}

Was this helpful?