Description

Start a job on the OEM instance. The job runs asynchronously. Use List Jobs to track its progress.

Authentication

This endpoint requires a Bearer token in the Authorization header.

• Authorization: Bearer <token>. A valid Portal API session token or API token.

Request Body

The request body should be JSON-encoded.

• jobType: The type of job to start. Must be one of the documented types listed in Jobs.

Response Schema

On success, the endpoint returns identifiers for the newly created job.

• jobId: The unique identifier of the new job. Use this to find the job in subsequent List Jobs responses.
• jobState: The state of the new job. Always pending on a successful response.

Error Responses

• 400 Bad Request: The jobType field is missing or is not one of the allowed values.
• 401 Unauthorized: The Authorization header is missing or the token is not valid.
• 409 Conflict: A job of the requested jobType is already pending or running on the instance.

Example Request
POST https://<your-host>:9909/api/portal/v1/jobs
Authorization: Bearer <token>
Content-Type: application/json

{
    "jobType": "refresh-public-charts"
}

Example Response
Status Code: 200 OK
Response Body:
{
    "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "jobState": "pending"
}