projects.runs

Run API - Start

Start a Run for a Project.

post/{workspaceId}/projects/{projectName}/run/start

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

parametersobject required

The parameters to be passed to the API.

proxystring uri nullable

Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server. Use "intuned://auto" to let the platform pick a proxy for this project.

saveTraceboolean

requestTimeoutinteger

Timeout for the API request in seconds. Default is 10 minutes (600 seconds).

apistring required

The name of the API to be executed. This is the file path relative to the api folder inside your project.

Example request

{
  "parameters": {
    "param1": "value1",
    "param2": 42,
    "param3": true
  },
  "proxy": "http://username:password@domain:port",
  "requestTimeout": 600,
  "retry": {
    "maximumAttempts": 3
  },
  "authSession": {
    "checkAttempts": 3,
    "createAttempts": 3,
    "proxy": "http://username:password@domain:port",
    "requestTimeout": 600,
    "saveTrace": true,
    "runtimeInput": {
      "username": "user",
      "password": "pass"
    }
  },
  "sink": {
    "url": "https://example.com/webhook",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "apisToSend": [
      "api1",
      "api2"
    ]
  }
}

Response

Run started successfully.

runIdstring required

Unique identifier for the run, prefixed nanoId (ru_...)

status'pending' required

Changes

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