Workspaces API

Version: 1.0

Create instance

POST

/workspace/instances

Create a brand new Evo instance. Note: This endpoint is restricted to allowlisted service clients only.

Request

Body parameters

Required

display_namestring

Required

(1, 100) chars

hub_codestring

Required

instance_idstring | null

org_iduuid

Required

owner_iduuid

Required

The id of the Bentley user to give initial ownership permission for the instance.

type"commercial" | "partner" | "sandbox" | "internal"

Default: "commercial"

Example body

{
  "display_name": "string",
  "hub_code": "string",
  "instance_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "owner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "commercial"
}

Responses

201

Successful Response

Response schema

context_iduuid

created_atdate-time

created_bystring | string

Any of:

string

string

hub_codestring

hub_display_namestring

hub_type"enterprise" | "multitenant"

hub_urlstring

instance_iduuid

instance_namestring

instance_status"active" | "inactive" | "new"

instance_type"commercial" | "partner" | "sandbox" | "internal"

org_iduuid

org_namestring

updated_atdate-time

updated_bystring | string

Any of:

string

string

Example response

{
  "context_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hub_code": "string",
  "hub_display_name": "string",
  "hub_type": "enterprise",
  "hub_url": "string",
  "instance_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "instance_name": "string",
  "instance_status": "active",
  "instance_type": "commercial",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "org_name": "string",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "updated_by": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}