Assign connectors to an application

post

https://{hostname}/crux/v1/mgmt-pop/apps/{applicationId}/agents

Assign connectors to an application. To unassign connectors from an application, set the method parameter to delete. Provide a body with an agents array containing the connector uuid_url string values to remove. The API responds with a 204 code and no data.

Path Params

applicationId

string

required

A unique identifier for each application.

Query Params

contractId

string

required

The Akamai contract identifier for your Enterprise Application Access product.

method

string

enum

Enum When set to delete, unassigns the specified connectors from the application instead of assigning them. Provide an agents array in the request body with the connector uuid_url string values to remove.

Allowed:

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Target connectors for deploying the application configuration. For unassignment (method=delete), the agents array requires plain uuid_url strings, not objects.

agents

array of objects

required

Connectors to assign to the application.

agents*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

Connectors successfully unassigned. Returned when method=delete.

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Connectors successfully assigned.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.