Skip to content

DELETE /bulk/jobs/{job_id} API

  • Bulk

Cancel a pending or in-progress bulk job.

Parameters
NameInTypeRequiredDescription
job_idpathstringYesUnique identifier for the asynchronous bulk job.
  • job_idpathRequired
    Typestring

    Unique identifier for the asynchronous bulk job.

Sample responses
  • 202 Success — Cancellation accepted. The job will transition to `cancelled`.
  • 401 Client error — Missing or invalid API key.

    application/problem+jsonProblem

    {
    "type": "https://docs.geobridge.io/problems/unauthorized",
    "title": "Unauthorized",
    "status": 401,
    "detail": "API key is missing or invalid."
    }
  • 404 Client error — Requested job was not found.

    application/problem+jsonProblem

    {
    "type": "https://docs.geobridge.io/problems/not-found",
    "title": "Not Found",
    "status": 404,
    "detail": "No job exists with id 00000000-0000-4000-8000-000000000000."
    }
  • 409 Client error — Job can no longer be cancelled (already terminal).

    application/problem+jsonProblem

    {
    "type": "https://docs.geobridge.io/problems/conflict",
    "title": "Conflict",
    "status": 409,
    "detail": "Job 123e4567-e89b-12d3-a456-426614174000 has already completed."
    }
  • 429 Client error — Too many requests. Retry after the rate limit resets.

    application/problem+jsonProblem

    {
    "type": "https://docs.geobridge.io/problems/too-many-requests",
    "title": "Too Many Requests",
    "status": 429,
    "detail": "Job cancellation may only be attempted once every 5 seconds."
    }
  • 500 Server error — Unexpected server error.

    application/problem+jsonProblem

    {
    "type": "https://docs.geobridge.io/problems/internal-error",
    "title": "Internal Server Error",
    "status": 500,
    "detail": "Unexpected exception while cancelling the job."
    }
Code samples

202 Accepted

Terminal window
# 202 Accepted — Cancels a running job that is still in a cancellable state.
curl -s -X DELETE 'https://api-na.geobridge.io/v1/bulk/jobs/123e4567-e89b-12d3-a456-426614174000' \
-H 'Accept: application/json' \
-H 'X-API-Key: YOUR_API_KEY'

401 Unauthorized

Terminal window
# 401 Unauthorized — Missing API key when attempting to cancel a job.
# Deliberately omits X-API-Key header to demonstrate 401 Unauthorized.
curl -s -X DELETE 'https://api-na.geobridge.io/v1/bulk/jobs/123e4567-e89b-12d3-a456-426614174000' \
-H 'Accept: application/json'

429 Too Many Requests

Terminal window
# 429 Too Many Requests — Cancellation attempts are throttled after repeated requests.
curl -s -X DELETE 'https://api-na.geobridge.io/v1/bulk/jobs/123e4567-e89b-12d3-a456-426614174000' \
-H 'Accept: application/json' \
-H 'X-API-Key: YOUR_API_KEY'

404 Not Found

Terminal window
# 404 Not Found — Cancelling an unknown job id returns 404.
curl -s -X DELETE 'https://api-na.geobridge.io/v1/bulk/jobs/00000000-0000-4000-8000-000000000000' \
-H 'Accept: application/json' \
-H 'X-API-Key: YOUR_API_KEY'

409 Conflict

Terminal window
# 409 Conflict — Job already completed, so cancellation is rejected.
curl -s -X DELETE 'https://api-na.geobridge.io/v1/bulk/jobs/123e4567-e89b-12d3-a456-426614174000' \
-H 'Accept: application/json' \
-H 'X-API-Key: YOUR_API_KEY'

500 Internal Server Error

Terminal window
# 500 Internal Server Error — Handles server-side failure when calling cancel.
curl -s -X DELETE 'https://api-na.geobridge.io/v1/bulk/jobs/123e4567-e89b-12d3-a456-426614174000' \
-H 'Accept: application/json' \
-H 'X-API-Key: YOUR_API_KEY'
Try it live

Save your API key once and reuse it across endpoints. Configure the request below and send it directly from the docs.

Stored locally in your browser. Removing it clears access for this device.

Path parameters

Unique identifier for the asynchronous bulk job.

Configure the request and select “Send request” to preview the response.