SEseqeralabs
agents

Update agent

Changed on

Replaces an agent in a workspace. Every field is overwritten, so an omitted optional field is cleared.

put/agents/{agentId}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

agentIdstring required

Agent string identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

Request body

agentInstructionsstring required

Instructions the agent follows. Must not be blank

agentInstructionsTemplateIdstring nullable

Template the instructions were created from. Surrounding whitespace is trimmed, and a blank value is stored as null

descriptionstring nullable

Surrounding whitespace is trimmed, and a blank value is stored as null

githubAppCredentialIdstring nullable

GitHub App credential in the workspace the agent uses for repository access. Surrounding whitespace is trimmed, and a blank value is stored as null

namestring required

Agent name, unique in the workspace. Letters, digits, dashes and underscores only. Surrounding whitespace is trimmed

serviceAccountIdinteger required

Service account the agent runs as. It must be enabled, be a participant of the workspace, and have a workspace role that grants agent:execute (launch, maintain, admin or owner)

Response

OK

Changes

  • adab9fd613a4Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^[A-Za-z0-9_-]+$ to the request property

    • warning

      the request property's maxLength was set to 50000

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 120

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's min was set to 1.00

    • info

      added the optional property / to the response with the status

    • info

      the / response's property pattern ^[A-Za-z0-9_-]+$ was added for the status

  • 24f327d93421Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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