{"_id":"56cce1f7ca43550b002814d9","user":"55fae9d4825d5f19001fa379","__v":174,"parentDoc":null,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"category":{"_id":"561d4c78281aec0d00eb27b6","pages":["561d4ce96386060d00e0600c","561d4d3a6386060d00e0600e","561d4d7431d9630d001eb5c5","56268a0cc2781f0d00364bba","56269097c2781f0d00364bd1","562697d0e2ce610d004e3da8","565f63c3bca87d0d006bc729","5662003255e4450d00e62c9b","566200df36398e0d00f79623","5667219ff672550d00085220","5671be061b6b730d008b4893","56cce1f7ca43550b002814d9","56d743f43513421d0093431b","56d760a6693ef41d0003abe2","56ddf7f52793543200cdc9d5","56df11f85469d02000534e56","56e1bc4c150ed52d0062c66d","56e1bd57a2494b34007f2e57","56e6daeacec7530e006a70e9","56e703e6cb97fd200068ecf2","56e82b56130a993400a647ed","56e83d108e380a2000b7ece2"],"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","__v":22,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-13T18:24:56.657Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"project":"55faeacad0e22017005b8265","updates":["56eaf1501d0655290054558b","56eb01fad326c30e007caa19"],"next":{"pages":[],"description":""},"createdAt":"2016-02-23T22:49:27.228Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"# Root: https://geobigdata.io\n\n# API Endpoints\n\nClick the name to see full reference material for the API endpoint.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"API Endpoint\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"[/auth/v1/oauth/token/](#/auth/v1/oauth/token/)\",\n    \"0-1\": \"Authentication API - Get Token\",\n    \"1-0\": \"[/orders/v2/order](#/orders/v2/order)\",\n    \"1-1\": \"Ordering API\",\n    \"2-0\": \"[/catalog/v2/search](#/catalog/v2/search)\",\n    \"2-1\": \"Catalog V2 API - Search\",\n    \"3-0\": \"[/catalog/v2/record](#/catalog/v2/record)\",\n    \"3-1\": \"Catalog V2 API - Records\",\n    \"4-0\": \"[/workflows/v1/tasks](#/workflows/v1/tasks)\",\n    \"4-1\": \"Workflow API - Tasks\",\n    \"5-0\": \"[/workflows/v1/workflows](#/workflows/v1/workflows)\",\n    \"5-1\": \"Workflow API - Workflows\",\n    \"6-0\": \"[/workflows/v1/workflows/search](#/workflows/v1/workflows/search)\",\n    \"6-1\": \"Workflow API - Workflow Search\",\n    \"7-0\": \"[/workflows/v1/schemas/](#/workflows/v1/schemas)\",\n    \"7-1\": \"Workflow API - Workflow and Task Schemas\",\n    \"8-0\": \"[/s3creds/v1/prefix](#/s3creds/v1/prefix)\",\n    \"8-1\": \"S3 Storage Service\",\n    \"9-0\": \"[/thumbnails/v1](#/thumbnails/v1)\",\n    \"9-1\": \"Thumbnail Service\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n\n\n\n# API Reference \n\n\n# <a name=\"/auth/v1/oauth/token/\"></a>auth/v1/oauth/token/\n\nType | URL | Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/auth/v1/oauth/token/ |Get a token | [Get OAuth Token (api-key)](doc:get-oauth-token) \n\n### Response \n\nThe response to a request for a token includes the following:\n\nName | Value\n--- | ---\naccess_token | The string is your token. This is what you use to make API calls.\ntoken_type | Bearer\nexpires_in | 604800 seconds, or 7 days\nrefresh_token | A refresh token can replace an expired token*\nscope | Scope is not being used at this time. \n\n*Refresh token: Refresh token can be used to replace an expired token. However, for most use cases, it may be easier to simply get a new token by sending another \"Get a Token\" request.\n\n\n\n#  <a name=\"/orders/v2/order\"></a>/orders/v2/order\n\nType | URL | Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/orders/v2/heartbeat | Check heartbeat | [Orders Heartbeat v2](doc:orders-heartbeat-v2) \nPOST |https://geobigdata.io/orders/v2/order | Place an Order | [Place an Order v2](doc:place-an-order-v2)\nGET |https://geobigdata.ioorders/v2/order/<order_id> | Get order status | [Get Order Status v2](doc:get-order-status-v2)\n\n### Response Attributes and Values\nAttribute | Description\n--- | ----\norder_id | The ID assigned to the order. \nacquisitions | The acquisitions that were part of the order. \nacquisition_id | A separate line item for each acquisition that was part of the order. \nstate | The status of the acquisition that was ordered. See the Order States table below.\n\nOrder States | Description\n--- | ---\nsubmitted | The order has been submitted to the GBDX platform\nordering | The acquisitions are being ordered from the DigitalGlobe (DG) factory\nplaced | The order has been placed with the DG factory. \ndelivered | The acquisition has been delivered from the DG factory and is available\nfailed | The order failed. \n\n# <a name=\"/catalog/v2/search\"></a>/catalog/v2/search\nType | URL| Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/catalog/v2/heartbeat | Check the Catalog V2 API's heartbeat | [Catalog V2 Heartbeat](doc:catalog-heartbeat-v2) \nGET | https://geobigdata.io/catalog/v2/ | Search the Catalog by area, date range, types, or filters | [Catalog V2 Search by Spatial Area](doc:catalog-v2-search-by-spatial-area) [\n\n# <a name=\"/catalog/v2/record\"></a>/catalog/v2/record\n\nCatalog V2 allows a \"Get a Record\" request.\n\nType | URL| Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/catalog/v2/record/:recordID _ Get a record by ID | [Catalog V2 Get a Record](doc:catalog-v2-get-a-record) \n\n# <a name=\"/workflows/v1/tasks\"></a>/workflows/v1/tasks\n\nType | URL| Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/workflows/v1/heartbeat | Check heartbeat | [Workflows Heartbeat](doc:workflows-heartbeat) \nGET | https://geobigdata.io/workflows/v1/tasks | List all tasks in the task registry | [List Tasks](doc:list-tasks-in-thetask-registry) \nPOST | https://geobigdata.io/workflows/v1/tasks | Register a task  | [Register a task](doc:register-a-task-with-the-task-registry) \nGET | https://geobigdata.io/workflows/v1/tasks/task_id | Get a task definition from the task registry | [Get Task Definition](doc:get-a-task-definition-from-the-task-registry) \nDELETE | https://geobigdata.io/workflows/v1/tasks/task_id | Delete a Task | [Delete a Task](doc:delete-a-task) \n\n\n\nTasks must be registered in the Workflow Task Registry. To find a complete list of tasks, [List Tasks](doc:list-tasks-in-thetask-registry). The task name is the task ID. \n\nPlease see the [Task and Workflow Course](doc:task-and-workflow-course) for complete descriptions of the task definition.\n\n# <a name=\"/workflows/v1/workflows\"></a>/workflows/v1/workflows\n\nType | URL| Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/workflows/v1/workflows | Get a list of workflows | [List Workflows](doc:list-worklflows) \nPOST | https://https://geobigdata.io/workflows/v1/workflows | Submit a workflow | [Submit a Workflow](doc:submit-a-workflow) \nGET | https://geobigdata.io/workflows/workflow_id | Get a workflow and its Status | [Get Workflow Status](docs/get-workflow-status)\nGET | https://geobigdata.io/workflows/workflow_id/events | Get a workflow's status events | [Workflow status events](doc:get-a-workflows-status-events) \nPOST | https://geobigdata.io//workflows/v1/workflows/:workflow_id/cancel | Cancel a Workflow | [Cancel a Workflow](doc:cancel-a-workflow) \nGET | https://geobigdata.io/workflows/v1/workflows/workflow_id/tasks/task_id/stdout | Get the stdout output from a completed task in a workflow | [STDOUT output from a workflow task](doc:stdout-output-from-a-workflow-task) \nGET | https://geobigdata.io/workflows/v1/workflows/workflow_id/tasks/task_id/stderr | Get the stderr output from a completed task in a workflow | [STDERR output from a workflow task](doc:stderr-output-from-a-workflow-task) \n\n# <a name=\"/workflows/v1/workflows/search\"></a>/workflows/v1/workflows/search\n\n### API Calls\nType | URL| Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io//workflows/v1/workflows/search | List workflow filters | [List workflow filters](doc:list-available-filters-for-workflows) \nPOST | https://geobigdata.io//workflows/v1/workflows/search | Search workflows by filter | [Search Workflows](doc:search-for-workflows-by-filter) \n\n### Workflow Filter Properties\n\nProperty | Value | Type | Description\n--- | --- | --- | ---\nowner | 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.\nstate | see list below | enum |  State to filter by\nlookback_h | 0 to 720 | number | Look back time in hours\n\n#### Workflow States\n\n\t* submitted\n\t* scheduled\n\t* started\n\t* canceled\n\t* cancelling\n\t* failed\n\t* succeeded\n\t* timedout\n\t* pending\n\t* running\n\t* complete\n\t* all\n\nPlease see the [Task and Workflow Course](doc:task-and-workflow-course) for complete descriptions of the workflow definition.\n\n# <a name=\"/workflows/v1/schemas\"></a>/workflows/v1/schemas\n\nType | URL | Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/workflows/v1/schemas/TaskDescriptor | Get the Task Definition Schema | [Task Definition Schema](doc:get-the-task-definition-schema) \nGET | https://geobigdata.io/workflows/v1/schemas/WorkflowDescriptor | Get the Workflow Definition Schema | [Workflow Definition Schema](doc:get-the-workflow-schema) \n\nPlease see the [Task and Workflow Course](doc:task-and-workflow-course) for complete descriptions of the task and workflow definitions.\n\n# <a name=\"/s3creds/v1/prefix\"></a>/s3creds/v1/prefix\n\n\nType | URL| Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/s3creds/v1/prefix?duration=3600 | Get temp creds to access S3 bucket | [Get Temp S3 Creds](doc:temp-credentials-for-a-prefix) \nPUT | https://geobigdata.io/s3creds/v1/prefix | Update a Prefix | [Update a Prefix](doc:update-a-prefix) \nGET | https://geobigdata.io/s3creds/v1/prefix | Get prefix size | [Get Prefix Size](doc:get-prefix-size) \n\nNote: If the prefix does not exist it will be created implicitly\n\nThe credentials provided by the GBDX S3 Storage Service are temporary and session-based. When a request is made for credentials, the system will return:\n\n* Bucket (The S3 Bucket is gbd-customer-data)\n* Prefix (The Prefix is your account ID)\n* S3_access_key\n* S3_session_token\n\n\n__Duration Type__ | __Value__ |\n--- | --- |\nMinimum |900 seconds (.25 hours) \nDefault | 3600 seconds (1 hour) \nMaximum |129600 seconds (36 hours)\n\n# <a name=\"/thumbnails/v1\"></a>/thumbnails/v1\n\nType | URL | Description | Try it Out\n--- | --- | --- | ---\nGET | https://geobigdata.io/thumbnails/v1/browse/catid.dim.png |Browse Mode | [Browse Mode](doc:browse-mode) \nGET | https://geobigdata.io/thumbnails/v1/metadata/catid.json | Metadata Mode | [Metadata Mode](doc:metadata-mode) \nGET | https://geobigdata.io/thumbnails/v1/get/catid.dim.png | JSON Mode | [JSON Mode](doc:json-mode) \nGET | https://geobigdata.io/thumbnails/v1/thumbnail/catid.dim.orientation.img | Thumbnail Mode |[Thumbnail Mode](doc:thumbnail-mode) \n\n\n\n### Parameters\n\nParameter | Type | Required? | Description\n--- | --- | --- | ---\ncatID | string | yes | catalog identifier for the required image\ndim | string | no | small, medium, large, natres\norientation | string | no | STANDARD, MAXWIDTH, MAXHEIGHT, NATRES\nimg | string | no | TRUE, FALSE (available for thumbnail mode only)\n\n\n### Dimensions\n\nValid dimensions are:\n*small\n*medium\n*large\n*natres\n\n### Orientation \n\nNOTE: All modes maintain aspect ratio\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"STANDARD\",\n    \"0-1\": \"'fit' the image so that the longest extent will not exceed the requested dimension\",\n    \"1-0\": \"MAXWIDTH\",\n    \"1-1\": \"'fit' the image so that the width will not exceed the requested dimension\",\n    \"2-0\": \"MAXHEIGHT\",\n    \"2-1\": \"'fit' the image so that the height will not exceed the requested dimension\",\n    \"3-0\": \"NATRES\",\n    \"3-1\": \"Do not 'fit' the image. Use its original extents.\",\n    \"h-0\": \"Orientation\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n#### IMG Flag:\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"img = TRUE\",\n    \"0-1\": \"The img = TRUE flag will return an img tag to make the image easily viewable in a web page for testing.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"Complete API reference materials for the GBDX platform.","slug":"api-reference","type":"basic","title":"API Reference"}

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. [block:parameters] { "data": { "h-0": "API Endpoint", "h-1": "Description", "0-0": "[/auth/v1/oauth/token/](#/auth/v1/oauth/token/)", "0-1": "Authentication API - Get Token", "1-0": "[/orders/v2/order](#/orders/v2/order)", "1-1": "Ordering API", "2-0": "[/catalog/v2/search](#/catalog/v2/search)", "2-1": "Catalog V2 API - Search", "3-0": "[/catalog/v2/record](#/catalog/v2/record)", "3-1": "Catalog V2 API - Records", "4-0": "[/workflows/v1/tasks](#/workflows/v1/tasks)", "4-1": "Workflow API - Tasks", "5-0": "[/workflows/v1/workflows](#/workflows/v1/workflows)", "5-1": "Workflow API - Workflows", "6-0": "[/workflows/v1/workflows/search](#/workflows/v1/workflows/search)", "6-1": "Workflow API - Workflow Search", "7-0": "[/workflows/v1/schemas/](#/workflows/v1/schemas)", "7-1": "Workflow API - Workflow and Task Schemas", "8-0": "[/s3creds/v1/prefix](#/s3creds/v1/prefix)", "8-1": "S3 Storage Service", "9-0": "[/thumbnails/v1](#/thumbnails/v1)", "9-1": "Thumbnail Service" }, "cols": 2, "rows": 10 } [/block] # API Reference # <a name="/auth/v1/oauth/token/"></a>auth/v1/oauth/token/ Type | URL | Description | Try it Out --- | --- | --- | --- GET | https://geobigdata.io/auth/v1/oauth/token/ |Get a token | [Get OAuth Token (api-key)](doc:get-oauth-token) ### Response The response to a request for a token includes the following: Name | Value --- | --- access_token | The string is your token. This is what you use to make API calls. token_type | Bearer expires_in | 604800 seconds, or 7 days refresh_token | A refresh token can replace an expired token* scope | Scope is not being used at this time. *Refresh token: Refresh token can be used to replace an expired token. However, for most use cases, it may be easier to simply get a new token by sending another "Get a Token" request. # <a name="/orders/v2/order"></a>/orders/v2/order Type | URL | Description | Try it Out --- | --- | --- | --- GET | https://geobigdata.io/orders/v2/heartbeat | Check heartbeat | [Orders Heartbeat v2](doc:orders-heartbeat-v2) POST |https://geobigdata.io/orders/v2/order | Place an Order | [Place an Order v2](doc:place-an-order-v2) GET |https://geobigdata.ioorders/v2/order/<order_id> | Get order status | [Get Order Status v2](doc:get-order-status-v2) ### Response Attributes and Values Attribute | Description --- | ---- order_id | The ID assigned to the order. acquisitions | The acquisitions that were part of the order. acquisition_id | A separate line item for each acquisition that was part of the order. state | The status of the acquisition that was ordered. See the Order States table below. Order States | Description --- | --- submitted | The order has been submitted to the GBDX platform ordering | The acquisitions are being ordered from the DigitalGlobe (DG) factory placed | The order has been placed with the DG factory. delivered | The acquisition has been delivered from the DG factory and is available failed | The order failed. # <a name="/catalog/v2/search"></a>/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](doc:catalog-heartbeat-v2) GET | https://geobigdata.io/catalog/v2/ | Search the Catalog by area, date range, types, or filters | [Catalog V2 Search by Spatial Area](doc:catalog-v2-search-by-spatial-area) [ # <a name="/catalog/v2/record"></a>/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](doc:catalog-v2-get-a-record) # <a name="/workflows/v1/tasks"></a>/workflows/v1/tasks Type | URL| Description | Try it Out --- | --- | --- | --- GET | https://geobigdata.io/workflows/v1/heartbeat | Check heartbeat | [Workflows Heartbeat](doc:workflows-heartbeat) GET | https://geobigdata.io/workflows/v1/tasks | List all tasks in the task registry | [List Tasks](doc:list-tasks-in-thetask-registry) POST | https://geobigdata.io/workflows/v1/tasks | Register a task | [Register a task](doc:register-a-task-with-the-task-registry) GET | https://geobigdata.io/workflows/v1/tasks/task_id | Get a task definition from the task registry | [Get Task Definition](doc:get-a-task-definition-from-the-task-registry) DELETE | https://geobigdata.io/workflows/v1/tasks/task_id | Delete a Task | [Delete a Task](doc:delete-a-task) Tasks must be registered in the Workflow Task Registry. To find a complete list of tasks, [List Tasks](doc:list-tasks-in-thetask-registry). The task name is the task ID. Please see the [Task and Workflow Course](doc:task-and-workflow-course) for complete descriptions of the task definition. # <a name="/workflows/v1/workflows"></a>/workflows/v1/workflows Type | URL| Description | Try it Out --- | --- | --- | --- GET | https://geobigdata.io/workflows/v1/workflows | Get a list of workflows | [List Workflows](doc:list-worklflows) POST | https://https://geobigdata.io/workflows/v1/workflows | Submit a workflow | [Submit a Workflow](doc:submit-a-workflow) GET | https://geobigdata.io/workflows/workflow_id | Get a workflow and its Status | [Get Workflow Status](docs/get-workflow-status) GET | https://geobigdata.io/workflows/workflow_id/events | Get a workflow's status events | [Workflow status events](doc:get-a-workflows-status-events) POST | https://geobigdata.io//workflows/v1/workflows/:workflow_id/cancel | Cancel a Workflow | [Cancel a Workflow](doc:cancel-a-workflow) GET | https://geobigdata.io/workflows/v1/workflows/workflow_id/tasks/task_id/stdout | Get the stdout output from a completed task in a workflow | [STDOUT output from a workflow task](doc:stdout-output-from-a-workflow-task) GET | https://geobigdata.io/workflows/v1/workflows/workflow_id/tasks/task_id/stderr | Get the stderr output from a completed task in a workflow | [STDERR output from a workflow task](doc:stderr-output-from-a-workflow-task) # <a name="/workflows/v1/workflows/search"></a>/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](doc:list-available-filters-for-workflows) POST | https://geobigdata.io//workflows/v1/workflows/search | Search workflows by filter | [Search Workflows](doc:search-for-workflows-by-filter) ### 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](doc:task-and-workflow-course) for complete descriptions of the workflow definition. # <a name="/workflows/v1/schemas"></a>/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](doc:get-the-task-definition-schema) GET | https://geobigdata.io/workflows/v1/schemas/WorkflowDescriptor | Get the Workflow Definition Schema | [Workflow Definition Schema](doc:get-the-workflow-schema) Please see the [Task and Workflow Course](doc:task-and-workflow-course) for complete descriptions of the task and workflow definitions. # <a name="/s3creds/v1/prefix"></a>/s3creds/v1/prefix Type | URL| Description | Try it Out --- | --- | --- | --- GET | https://geobigdata.io/s3creds/v1/prefix?duration=3600 | Get temp creds to access S3 bucket | [Get Temp S3 Creds](doc:temp-credentials-for-a-prefix) PUT | https://geobigdata.io/s3creds/v1/prefix | Update a Prefix | [Update a Prefix](doc:update-a-prefix) GET | https://geobigdata.io/s3creds/v1/prefix | Get prefix size | [Get Prefix Size](doc:get-prefix-size) 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) # <a name="/thumbnails/v1"></a>/thumbnails/v1 Type | URL | Description | Try it Out --- | --- | --- | --- GET | https://geobigdata.io/thumbnails/v1/browse/catid.dim.png |Browse Mode | [Browse Mode](doc:browse-mode) GET | https://geobigdata.io/thumbnails/v1/metadata/catid.json | Metadata Mode | [Metadata Mode](doc:metadata-mode) GET | https://geobigdata.io/thumbnails/v1/get/catid.dim.png | JSON Mode | [JSON Mode](doc:json-mode) GET | https://geobigdata.io/thumbnails/v1/thumbnail/catid.dim.orientation.img | Thumbnail Mode |[Thumbnail Mode](doc:thumbnail-mode) ### 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 [block:parameters] { "data": { "0-0": "STANDARD", "0-1": "'fit' the image so that the longest extent will not exceed the requested dimension", "1-0": "MAXWIDTH", "1-1": "'fit' the image so that the width will not exceed the requested dimension", "2-0": "MAXHEIGHT", "2-1": "'fit' the image so that the height will not exceed the requested dimension", "3-0": "NATRES", "3-1": "Do not 'fit' the image. Use its original extents.", "h-0": "Orientation", "h-1": "Description" }, "cols": 2, "rows": 4 } [/block] #### IMG Flag: [block:parameters] { "data": { "0-0": "img = TRUE", "0-1": "The img = TRUE flag will return an img tag to make the image easily viewable in a web page for testing." }, "cols": 2, "rows": 1 } [/block]