Routing Profile¶

This section describes interactions with endpoints representing utilities or properties available at tenant level and which are not services as such.

Retrieve configuration¶

GET /api/v1/tenants/(string: tenant_id)/routing_profile/¶

Get the details about the routing profile of the tenant.

Example request:

GET /api/v1/tenants/foo/routing_profile/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "routingProfile": "routing"
}

Response JSON Object:

Status Codes:

PUT /api/v1/tenants/(string: tenant_id)/routing_profile/¶

Update the routing profile of the tenant.

Authorization Right: Minimum Tenant Admin.

Example request:

PUT /api/v1/tenants/foo/routing_profile/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "routingProfile": "routing"
}

Request JSON Object:

routingProfile (string) – (Required) The routing profile name, must be inline with what is supported by the Main AS (See Retrieve available routing profiles).

Example response:

Response:

Similar to GET instance method response.

Status Codes: