AWawork-io
customAgents

Links a connector to an agent.

Changed on

Links an existing connector to the specified agent and returns the linked connector. Use GET /agents/connectors to find a connector id. <Check title="Required Permissions" icon="key">The user must have manage access to the agent.</Check>

post/agents/{agentId}/connectors/{connectorId}

Request

  • Base URL
    https://api.awork.com/api/v1
  • URL
    https://api.awork.com/api/v1/agents/{agentId}/connectors/{connectorId}
  • Auth
    HTTP bearer

Path parameters

agentIdstring uuid required

The agent id.

connectorIdstring uuid required

The connector id.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

ownerUserIdstring uuid nullable

The connector owner, or null for a preset without configuration. CreatedBy remains audit history.

canDeleteboolean

Whether the requesting user can delete the connector and all its connections.

hasAdminAccessOnlyboolean

Whether the requesting user has only workspace administrator access to the connector. The user can manage the connector, but cannot use it or add a connection to it.

namestring nullable

The connector display name.

descriptionstring nullable

The connector description.

urlstring nullable

The custom connector URL.

presetKeystring nullable

The predefined connector key.

logoPathstring nullable

The preset logo path when this server matches a catalog preset.

statusstring nullable

The aggregate connection status.

isSharedWithWorkspaceboolean

Whether the connector is shared with the workspace.

isOwnerboolean

Whether the current user owns the connector.

currentUserConnectionStatusstring nullable

The current user's connection status.

lastRefreshedOnstring date-time nullable

When the server tools were last refreshed.

currentUserLastAuthenticatedOnstring date-time nullable

When the current user last authenticated this server.

hasOAuthClientConfigurationboolean

Whether static OAuth client credentials are configured.

connectionModestring nullable

The selected connection resolution mode for an agent-linked response.

connectionIdstring uuid nullable

The selected specific connection, when applicable.

currentUserConnectionIdstring uuid nullable

The connection selected by the current user for acting-user resolution.

Changes

  • 84f37b3c4cbcRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

  • 5332322ffca3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status