Changelog

Summary

• Introduced new endpoints for managing Agent Tokens, including listing, creating, retrieving, and deleting tokens.
• Added a new schema CreateAgentTokenRequest for creating Agent Tokens with properties such as name, description, and tokenExpiryPeriodInDays.

Added

• Schemas

  • CreateAgentTokenRequest
    • name (string): The name of the Agent token. Required.
    • description (string): The description for the Agent token.
    • tokenExpiryPeriodInDays (integer): The expiry period of the Agent token in days. Defaults to never expire if not specified. Range: 1 to 3650.

• Endpoints

  • GET /organizations/{organizationId}/deployments/{deploymentId}/agent-tokens

    • List Agent Tokens.
    • Parameters:
      • organizationId (path, string): The ID of the Organization.
      • deploymentId (path, string): The ID of the Deployment.
      • offset (query, integer): Number of results to skip. Default: 0.
      • limit (query, integer): Maximum number of results to return. Default: 20, Max: 1000.
      • sorts (query, array of strings): Fields to sort by. For example, name:asc.
    • Responses: 200, 400, 401, 403, 404, 500.

  • POST /organizations/{organizationId}/deployments/{deploymentId}/agent-tokens

    • Create an Agent token.
    • Parameters:
      • organizationId (path, string): The ID of the Organization.
      • deploymentId (path, string): The ID of the Deployment.
    • Request Body: CreateAgentTokenRequest
    • Responses: 200, 400, 401, 403, 404, 500.

  • GET /organizations/{organizationId}/deployments/{deploymentId}/agent-tokens/{agentTokenId}

    • Retrieve an Agent Token.
    • Parameters:
      • organizationId (path, string): The ID of the Organization.
      • deploymentId (path, string): The ID of the Deployment.
      • agentTokenId (path, string): The ID of the Agent token.
    • Responses: 200, 400, 401, 403, 404, 500.

  • DELETE /organizations/{organizationId}/deployments/{deploymentId}/agent-tokens/{agentTokenId}

    • Delete an Agent Token.
    • Parameters:
      • organizationId (path, string): The ID of the Organization.
      • deploymentId (path, string): The ID of the Deployment.
      • agentTokenId (path, string): The ID of the Agent token.
    • Responses: 204, 400, 401, 403, 404, 500.

Changed

• No existing schemas or endpoints were modified.