oCoreoCore Docs
API Reference

Bulk Operations

List bulk operations

Returns paginated list of bulk operations for the organization.

GET
/bulk-operations

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Query Parameters

pageinteger

Page number

per_pageinteger

Items per page

curl -X GET "//api.ocore.dev/api/bulk-operations?page=0&per_page=0" \
  -H "Authorization: <token>"

OK

{
  "items": [
    {
      "completedItems": 0,
      "createdAt": "string",
      "failedItems": 0,
      "id": "string",
      "operationType": "string",
      "status": "string",
      "totalItems": 0,
      "updatedAt": "string"
    }
  ],
  "total": 0
}

Create bulk operation

Creates a new bulk operation to run against multiple instances.

POST
/bulk-operations

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Bulk operation request

instanceIdsRequiredarray<string>
operationTypeRequiredstring
curl -X POST "//api.ocore.dev/api/bulk-operations" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceIds": [
      "string"
    ],
    "operationType": "string"
  }'

Accepted

{
  "completedItems": 0,
  "createdAt": "string",
  "failedItems": 0,
  "id": "string",
  "items": [
    {
      "completedAt": "string",
      "errorMessage": "string",
      "id": "string",
      "instanceId": "string",
      "instanceName": "string",
      "startedAt": "string",
      "status": "string"
    }
  ],
  "operationType": "string",
  "status": "string",
  "totalItems": 0,
  "updatedAt": "string"
}

Get bulk operation

Returns details of a bulk operation including its items.

GET
/bulk-operations/{id}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Bulk operation ID

curl -X GET "//api.ocore.dev/api/bulk-operations/<string>" \
  -H "Authorization: <token>"

OK

{
  "completedItems": 0,
  "createdAt": "string",
  "failedItems": 0,
  "id": "string",
  "items": [
    {
      "completedAt": "string",
      "errorMessage": "string",
      "id": "string",
      "instanceId": "string",
      "instanceName": "string",
      "startedAt": "string",
      "status": "string"
    }
  ],
  "operationType": "string",
  "status": "string",
  "totalItems": 0,
  "updatedAt": "string"
}

Retry failed bulk operation items

Retries all failed items in a bulk operation.

POST
/bulk-operations/{id}/retry

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Bulk operation ID

curl -X POST "//api.ocore.dev/api/bulk-operations/<string>/retry" \
  -H "Authorization: <token>"

Accepted

{
  "completedItems": 0,
  "createdAt": "string",
  "failedItems": 0,
  "id": "string",
  "items": [
    {
      "completedAt": "string",
      "errorMessage": "string",
      "id": "string",
      "instanceId": "string",
      "instanceName": "string",
      "startedAt": "string",
      "status": "string"
    }
  ],
  "operationType": "string",
  "status": "string",
  "totalItems": 0,
  "updatedAt": "string"
}

Was this page helpful?
Edit on GitHub

Topologies

Previous Page

Agency

Next Page