Update Engine

PUT 
/org/:orgId/engine/:engineId

Update the Engine Definition

Request

Path Parameters

orgId stringrequired

The Organization ID (UUID) for which you are querying.

engineId stringrequired

The Engine ID (UUID) for which you are querying.

application/json

Body

required

any

Responses

200

Success.

application/json

Schema

Schema

engine_id string
org_id string
name string
protocol string
host string
port string
properties object
default_engine bool

Example (from schema)

{
  "engine_id": "94d12cde-7e75-4d45-53b8-1ec1d5b92982",
  "org_id": "default",
  "name": "My Engine",
  "protocol": "http",
  "host": "local.infra.atscale.com",
  "port": 10502,
  "properties": "{}",
  "default_engine": true
}

Example

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "engine_id": "94d12cde-7e75-4d45-53b8-1ec1d5b92982",
      "org_id": "default",
      "name": "My Engine",
      "protocol": "http",
      "host": "local.infra.atscale.com",
      "port": 10502,
      "properties": "{}",
      "default_engine": false
    }
  ]
}

401

This error will occur if calling user does not have access right for the API.

503

This error will occur if Design Center APIs are not enabled.

Loading...