Services/Scheduler

Endpoints related to managing an envrionment's scheduler service.

Create Scheduler Service Job

Creates a task that will update the scheduler service's configuration.

SecuritybearerAuth and hubAuth

Request

path Parameters

environmentId

required

string

The ID of the environment where this scheduler service resides.

Request Body schema: application/json

Parameters for reconfiguring a scheduler service.

action required	string The name of the action to perform. Value: "reconfigure"
required	object

Responses

202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/environments/{environmentId}/services/scheduler/tasks

Request samples

Payload

application/json

{"action": "reconfigure",
"contents": {"config": {"public": true,
"access_keys": [{"name": "string",
"secret": "string",
"ips": ["string"
]
}
]
},
"auto_update": true
}
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

➔ Next to Services/VPN