Skip to main content
POST
/
receive
/
metrics
/
jobs
Create a Receive Metrics job
curl --request POST \
  --url https://{host}/receive/metrics/jobs \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "parameters": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "jobId": "<string>",
  "name": "<string>",
  "job_status": {
    "code": 123,
    "message": "<string>",
    "files": [
      {
        "name": "<string>",
        "size": 123
      }
    ]
  }
}

Body

application/json
name
string

Defaults to the job GUID when omitted.

parameters
object[]

Array of name/value pairs; supported keys depend on your ingestion endpoint.

Response

Job created

jobId
string
required
name
string
required
job_status
object

Status of the last/active job operation:

  • code: 0 success; -1 error (or last audit load code if no statuscode.txt)
  • message: from statusmessage.txt (or last audit load status)
  • files: non-status files in the job status folder.