Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
POSTAgentSince 1.0SynchronousAuth Required

CreateDeployJob

Create a deployment job to install agents on a list of target node IPs

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • nodeIpsListRequired

    Node ips

    Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the deploy job

    Example: deploy-job-001

  • nodeIpsList

    Node ips

    Example: item1,item2

  • nodesList

    Nodes for this resource

    Example: (nested array)

    • nodeIpString

      IP address of the node in the deploy job

      Example: 192.168.1.10

    • statusString

      Deployment status for this node (pending, deploying, success, failed)

      Example: success

    • errorString

      Error message if deployment failed on this node

      Example: connection refused

  • statusString

    Overall status of the deploy job (pending, running, success, failed)

    Example: running

  • simulatedBoolean

    Whether this job is a simulation without actual deployment

    Example: false

  • createdAtString

    Created at

    Example: 2026-01-15T08:00:00Z

Endpoint

POST/api/v1/agents/deploy

/api/v1/agents/deploy

Operation ID

CreateDeployJob

Permalink

Request Example

curl -X POST '{host}/api/v1/agents/deploy' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"nodeIps":"item1,item2"}'

Response Example

200
{
  "id": "deploy-job-001",
  "nodeIps": [],
  "nodes": [
    {}
  ],
  "status": "running",
  "simulated": false,
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history