Assign connectors to an application

This assigns or unassigns connectors to an application. When you don't set the method parameter, send the assign request body, where each agents field is an object with a uuid_url. Assigning connectors switches the application's connector association type to connectors and removes any existing application access group or connector pool association. The response includes only the connectors the request newly assigned and skips connectors that are already assigned, so it can be an empty array. To unassign connectors from an application, set the method parameter to delete and send the unassign request body, where agents is an array of connector uuid_url strings. The API responds with a 204 code and no data. Unassigning a connector that isn't assigned isn't an error. The request responds with a 400 error if a connector or the application isn't found, if assigning would exceed the maximum number of applications for a connector, if the application has a manual configuration override and is deployed, or if the application is a tunnel app that isn't an SMB app and a Docker connector doesn't support client capability. If an assign request fails after the application's connector association type has changed, the changes aren't rolled back.

Path Params
string
required

A unique identifier for each application.

Query Params
string
required

The Akamai contract identifier for your Enterprise Application Access product.

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:
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 to deploy the application configuration. Use this request body when you don't set the method parameter.

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
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json