GBDX

API Reference

Complete API reference materials for the GBDX platform.

Root: https://geobigdata.io

API Endpoints

Click the name to see full reference material for the API endpoint.

API Endpoint
Description

Authentication API - Get Token

Ordering API

Catalog V2 API - Search

Catalog V2 API - Records

Workflow API - Tasks

Workflow API - Workflows

Workflow API - Workflow Search

Workflow API - Workflow and Task Schemas

S3 Storage Service

Thumbnail Service

/catalog/v2/search

Type URL Description Try it Out
GET https://geobigdata.io/catalog/v2/heartbeat Check the Catalog V2 API's heartbeat Catalog V2 Heartbeat
GET https://geobigdata.io/catalog/v2/ Search the Catalog by area, date range, types, or filters Catalog V2 Search by Spatial Area [

/catalog/v2/record

Catalog V2 allows a "Get a Record" request.

Type URL Description Try it Out
GET https://geobigdata.io/catalog/v2/record/:recordID _ Get a record by ID Catalog V2 Get a Record

/workflows/v1/tasks

Type URL Description Try it Out
GET https://geobigdata.io/workflows/v1/heartbeat Check heartbeat Workflows Heartbeat
GET https://geobigdata.io/workflows/v1/tasks List all tasks in the task registry List Tasks
POST https://geobigdata.io/workflows/v1/tasks Register a task Register a task
GET https://geobigdata.io/workflows/v1/tasks/task_id Get a task definition from the task registry Get Task Definition
DELETE https://geobigdata.io/workflows/v1/tasks/task_id:task version Delete a Task Delete a Task

Tasks must be registered in the Workflow Task Registry. To find a complete list of tasks, List Tasks. The task name is the task ID.

Please see the Task and Workflow Course for complete descriptions of the task definition.

/workflows/v1/workflows

/workflows/v1/workflows/search

API Calls

Type URL Description Try it Out
GET https://geobigdata.io//workflows/v1/workflows/search List workflow filters List workflow filters
POST https://geobigdata.io//workflows/v1/workflows/search Search workflows by filter Search Workflows

Workflow Filter Properties

Property Value Type Description
owner 1 to 50 string Owner to filter by. This filter is only available for super-users. For regular user the results are filtered by username.
state see list below enum State to filter by
lookback_h 0 to 720 number Look back time in hours

Workflow States

* submitted
* scheduled
* started
* canceled
* cancelling
* failed
* succeeded
* timedout
* pending
* running
* complete
* all

Please see the Task and Workflow Course for complete descriptions of the workflow definition.

/workflows/v1/schemas

Type URL Description Try it Out
GET https://geobigdata.io/workflows/v1/schemas/TaskDescriptor Get the Task Definition Schema Task Definition Schema
GET https://geobigdata.io/workflows/v1/schemas/WorkflowDescriptor Get the Workflow Definition Schema Workflow Definition Schema

Please see the Task and Workflow Course for complete descriptions of the task and workflow definitions.

/s3creds/v1/prefix

Note: If the prefix does not exist it will be created implicitly

The credentials provided by the GBDX S3 Storage Service are temporary and session-based. When a request is made for credentials, the system will return:

  • Bucket (The S3 Bucket is gbd-customer-data)
  • Prefix (The Prefix is your account ID)
  • S3_access_key
  • S3_session_token
Duration Type Value
Minimum 900 seconds (.25 hours)
Default 3600 seconds (1 hour)
Maximum 129600 seconds (36 hours)

/thumbnails/v1

Parameters

Parameter Type Required? Description
catID string yes catalog identifier for the required image
dim string no small, medium, large, natres
orientation string no STANDARD, MAXWIDTH, MAXHEIGHT, NATRES
img string no TRUE, FALSE (available for thumbnail mode only)

Dimensions

Valid dimensions are:
small medium
large natres

Orientation

NOTE: All modes maintain aspect ratio

Orientation
Description

STANDARD

'fit' the image so that the longest extent will not exceed the requested dimension

MAXWIDTH

'fit' the image so that the width will not exceed the requested dimension

MAXHEIGHT

'fit' the image so that the height will not exceed the requested dimension

NATRES

Do not 'fit' the image. Use its original extents.

IMG Flag:

img = TRUE

The img = TRUE flag will return an img tag to make the image easily viewable in a web page for testing.