projects.jobs

Create Job

Create a new Job for a Project.

post/{workspaceId}/projects/{projectName}/jobs

Request

  • Base URL
    https://app.intuned.io/api/v1/workspace
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring uuid required

Your workspace ID. How to find it?

projectNamestring required

The name you assigned when creating the Project.

Request body

idstring required

The ID of the job. Has to be a valid URL slug.

proxystring nullable

Proxy configuration for the job

Example request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "payload": [
    {
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      },
      "requestTimeout": 600,
      "retry": {
        "maximumAttempts": 3
      }
    }
  ],
  "configuration": {
    "retry": {
      "maximumAttempts": 3
    },
    "requestTimeout": 600,
    "proxy": "http://username:password@proxy.example.com:8080"
  },
  "sink": {
    "url": "https://example.com/webhook",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "apisToSend": [
      "api1",
      "api2"
    ]
  },
  "proxy": "http://username:password@proxy.example.com:8080",
  "auth_session": {
    "checkAttempts": 3,
    "createAttempts": 3
  },
  "notifications": [
    {
      "url": "https://example.com/webhook",
      "headers": {
        "Content-Type": "application/json",
        "Authorization": "Bearer token"
      }
    }
  ]
}

Response

Job created successfully.

idstring required

The ID of the created job.

message'created' required

Changes

No recorded changes to this operation across all 1 revision of this API.