Vendor API
Generated from the vendor API's own description of itself.
DataDrop vendor API, version 2.0.0.
listings
GET /v2/listings/{listing_id}/offers
List Vendor Listing Offers
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/sales
List Vendor Sales
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/listings/browse
Browse Listings
| Parameter | In | Type | Required |
|---|---|---|---|
query | query | string or null | no |
tags | query | array of string or null | no |
tag_slugs | query | array of string or null | no |
asset_types | query | array of string or null | no |
owned | query | boolean | no |
verified_only | query | boolean | no |
min_price | query | number or null | no |
max_price | query | number or null | no |
min_tasks | query | integer or null | no |
max_tasks | query | integer or null | no |
min_price_per_task | query | number or null | no |
max_price_per_task | query | number or null | no |
min_loc | query | integer or null | no |
max_loc | query | integer or null | no |
min_zip_files | query | integer or null | no |
max_zip_files | query | integer or null | no |
min_zip_size_gb | query | number or null | no |
max_zip_size_gb | query | number or null | no |
min_codebases | query | integer or null | no |
max_codebases | query | integer or null | no |
min_environments | query | integer or null | no |
max_environments | query | integer or null | no |
min_robotics_datasets | query | integer or null | no |
max_robotics_datasets | query | integer or null | no |
min_raw_data | query | integer or null | no |
max_raw_data | query | integer or null | no |
min_commits | query | integer or null | no |
max_commits | query | integer or null | no |
min_pull_requests | query | integer or null | no |
max_pull_requests | query | integer or null | no |
min_contributors | query | integer or null | no |
max_contributors | query | integer or null | no |
languages | query | array of string or null | no |
rare_languages_only | query | boolean | no |
file_extensions | query | array of string or null | no |
robotics_formats | query | array of string or null | no |
capabilities | query | array of string or null | no |
org | query | string or null | no |
sort | query | string | no |
limit | query | integer | no |
cursor | query | string or null | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/browse/access
Get Browse Access
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/listings/browse/by-ids
Browse Listings By Ids
| Parameter | In | Type | Required |
|---|---|---|---|
ids | query | array of string (uuid) or null | no |
sort | query | string | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/browse/{listing_id}
Browse Listing Detail
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/browse/{listing_id}/quality
Browse Listing Quality
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/browse/{listing_id}/tasksets/{taskset_id}
Browse Listing Taskset
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
taskset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/browse/{listing_id}/tasksets/{taskset_id}/tasks
Browse Listing Taskset Tasks
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
taskset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/qc-reports
List Vendor Qc Reports
| Parameter | In | Type | Required |
|---|---|---|---|
limit | query | integer | no |
offset | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/{listing_id}/qc
Get Listing Qc Report
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
task_rows | query | string | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/{listing_id}/assets
List Listing Assets
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/listings/{listing_id}/assets
Attach Listing Assets
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
Request body: application/json, ListingAssetsAttachRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/listings/{listing_id}/assets/{asset_id}
Detach Listing Asset
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PUT /v2/listings/{listing_id}/assets/{asset_id}/revision
Switch Listing Asset Revision
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
asset_id | path | string (uuid) | yes |
Request body: application/json, ListingAssetRevisionRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings
List Listings
| Parameter | In | Type | Required |
|---|---|---|---|
workspace_view | query | string | no |
lifecycle_stages | query | array of string or null | no |
query | query | string or null | no |
tags | query | array of string or null | no |
asset_types | query | array of string or null | no |
verified_only | query | boolean | no |
min_price | query | number or null | no |
max_price | query | number or null | no |
has_pending_offers | query | boolean | no |
no_assets | query | boolean | no |
min_tasks | query | integer or null | no |
max_tasks | query | integer or null | no |
min_loc | query | integer or null | no |
max_loc | query | integer or null | no |
min_zip_files | query | integer or null | no |
max_zip_files | query | integer or null | no |
min_zip_size_gb | query | number or null | no |
max_zip_size_gb | query | number or null | no |
min_commits | query | integer or null | no |
max_commits | query | integer or null | no |
min_pull_requests | query | integer or null | no |
max_pull_requests | query | integer or null | no |
min_merged_prs | query | integer or null | no |
max_merged_prs | query | integer or null | no |
min_contributors | query | integer or null | no |
max_contributors | query | integer or null | no |
min_source_files | query | integer or null | no |
max_source_files | query | integer or null | no |
min_test_files | query | integer or null | no |
max_test_files | query | integer or null | no |
sort | query | string | no |
limit | query | integer | no |
offset | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/listings
Create Listing
| Parameter | In | Type | Required |
|---|---|---|---|
Idempotency-Key | header | string or null | no |
Request body: application/json, ListingCreateRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/{listing_id}
Get Listing
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PATCH /v2/listings/{listing_id}
Update Listing
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
Request body: application/json, ListingUpdateRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/listings/{listing_id}/history
Get Listing History
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/listings/{listing_id}/submit
Submit Listing
| Parameter | In | Type | Required |
|---|---|---|---|
listing_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
wallet
GET /v2/wallet/earnings
List Earning Entries
| Parameter | In | Type | Required |
|---|---|---|---|
limit | query | integer | no |
offset | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
tasks
POST /v2/tasks/import
Import Tasks
Request body: application/json, TaskAssetImportRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/tasks/refresh-qc
Read Task Qc Refresh
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
POST /v2/tasks/refresh-qc
Refresh Task Qc
| Status | Meaning |
|---|---|
202 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/tasks/qc-facets
Read Task Qc Facets
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/tasks/{asset_id}
Get Task Asset
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PATCH /v2/tasks/{asset_id}
Update Task Asset
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, TaskAssetUpdateRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/tasks
List Task Assets
| Parameter | In | Type | Required |
|---|---|---|---|
stage | query | string or null | no |
id | query | array of string (uuid) or null | no |
group_id | query | string (uuid) or null | no |
listing_id | query | string (uuid) or null | no |
filter | query | array of string or null | no |
sort | query | string or null | no |
sort_direction | query | string | no |
limit | query | integer | no |
offset | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
codebases
GET /v2/codebases
List Codebases
| Parameter | In | Type | Required |
|---|---|---|---|
stage | query | string or null | no |
id | query | array of string (uuid) or null | no |
group_id | query | string (uuid) or null | no |
listing_id | query | string (uuid) or null | no |
filter | query | array of string or null | no |
sort | query | string or null | no |
sort_direction | query | string | no |
limit | query | integer | no |
offset | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/codebases
Create Codebase
Request body: application/json, CodebaseAssetCreateRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/codebases/batch
Create Codebases
Request body: application/json, CodebaseAssetBatchRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/codebases/languages
List Languages
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/codebases/{asset_id}
Get Codebase
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/codebases/{asset_id}
Delete Codebase
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PATCH /v2/codebases/{asset_id}
Update Codebase
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, CodebaseAssetUpdateRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/codebases/{asset_id}/data
Not supported: an API key cannot use a person's code-host connection; attach a codebase's data in the web app.
Attach Codebase Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, AssetForgeDataRequest or AssetUploadDataRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/codebases/{asset_id}/data
Not supported: a revision is never detached: attach a new one.
Detach Codebase Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/codebases/{asset_id}/data/refetch
Not supported: an API key cannot use a person's code-host connection; attach a codebase's data in the web app.
Refetch Codebase Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
202 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/codebases/{asset_id}/data/structure
Get Codebase Data Structure
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/codebases/{asset_id}/qc/runs
Not supported: checks run when a listing is submitted.
Start Codebase Qc Run
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
202 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/codebases/{asset_id}/qc
Get Codebase Qc
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
assets
GET /v2/assets
List Assets
| Parameter | In | Type | Required |
|---|---|---|---|
sku | query | string or null | no |
deprecated | query | boolean or null | no |
stage | query | string or null | no |
listing_id | query | string (uuid) or null | no |
group_id | query | string (uuid) or null | no |
id | query | array of string (uuid) or null | no |
limit | query | integer | no |
offset | query | integer | no |
attach_to | query | string (uuid) or null | no |
filter | query | array of string or null | no |
sort | query | string or null | no |
sort_direction | query | string | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/assets/window
List Asset Window
| Parameter | In | Type | Required |
|---|---|---|---|
sku | query | string or null | no |
deprecated | query | boolean or null | no |
stage | query | string or null | no |
listing_id | query | string (uuid) or null | no |
leaf_budget | query | integer | no |
header_budget | query | integer | no |
after_group_id | query | string (uuid) or null | no |
include_empty_groups | query | boolean | no |
attach_to | query | string (uuid) or null | no |
filter | query | array of string or null | no |
sort | query | string or null | no |
sort_direction | query | string | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/assets/{asset_id}
Get Asset
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/assets/{asset_id}
Delete Asset
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/assets/{asset_id}/revisions
List Asset Revisions
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/assets/{asset_id}/data/structure
Get Legacy Asset Data Structure
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
asset-groups
GET /v2/asset-groups
List Groups
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
POST /v2/asset-groups
Create Group
Request body: application/json, AssetGroupCreateRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/asset-groups/{group_id}
Get Group
| Parameter | In | Type | Required |
|---|---|---|---|
group_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/asset-groups/{group_id}
Delete Group
| Parameter | In | Type | Required |
|---|---|---|---|
group_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PATCH /v2/asset-groups/{group_id}
Rename Group
| Parameter | In | Type | Required |
|---|---|---|---|
group_id | path | string (uuid) | yes |
Request body: application/json, AssetGroupUpdateRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PUT /v2/asset-groups/{group_id}/assets/{asset_id}
Move Asset To Group
| Parameter | In | Type | Required |
|---|---|---|---|
group_id | path | string (uuid) | yes |
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
raw-data
GET /v2/raw-data
List Raw Data
| Parameter | In | Type | Required |
|---|---|---|---|
stage | query | string or null | no |
id | query | array of string (uuid) or null | no |
group_id | query | string (uuid) or null | no |
listing_id | query | string (uuid) or null | no |
filter | query | array of string or null | no |
sort | query | string or null | no |
sort_direction | query | string | no |
limit | query | integer | no |
offset | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/raw-data
Create Raw Data
Request body: application/json, RawDataAssetCreateRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/raw-data/sftp/open
List Open Sftp Uploads
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/raw-data/{asset_id}
Get Raw Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/raw-data/{asset_id}
Delete Raw Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
PATCH /v2/raw-data/{asset_id}
Update Raw Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, RawDataAssetUpdateRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/raw-data/{asset_id}/data
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
Attach Raw Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, AssetUploadDataRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/raw-data/{asset_id}/data
Not supported: a revision is never detached: attach a new one.
Detach Raw Data
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/raw-data/{asset_id}/data/structure
Get Raw Data Structure
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/raw-data/{asset_id}/qc/runs
Not supported: checks run when a listing is submitted.
Start Raw Data Qc Run
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
202 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/raw-data/{asset_id}/qc
Get Raw Data Qc
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/raw-data/{asset_id}/files/reserve
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
Reserve Raw Files
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, RawFilesReserveRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
408 | Request Timeout |
413 | Request Entity Too Large |
POST /v2/raw-data/{asset_id}/files/parts
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
Presign Raw File Parts
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, RawFilePartsRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
408 | Request Timeout |
413 | Request Entity Too Large |
POST /v2/raw-data/{asset_id}/files/parts/uploaded
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
List Raw File Uploaded Parts
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, RawFileUploadedPartsRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
408 | Request Timeout |
413 | Request Entity Too Large |
POST /v2/raw-data/{asset_id}/files/assemble
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
Assemble Raw File
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, RawFileAssembleRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
408 | Request Timeout |
413 | Request Entity Too Large |
GET /v2/raw-data/{asset_id}/files/status
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
Raw Files Status
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/raw-data/{asset_id}/sftp
Get Raw Data Sftp Login
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/raw-data/{asset_id}/sftp
Issue Raw Data Sftp Login
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/raw-data/{asset_id}/sftp
Revoke Raw Data Sftp Login
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/raw-data/{asset_id}/files/finish
Finish Raw Files
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
drop_cut_off | query | boolean | no |
keep_unconfirmed | query | boolean | no |
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
204 | Finished: the worker checks the upload, then its revision is attached |
POST /v2/raw-data/{asset_id}/files/complete
Not supported: raw data comes through an upload (POST /v2/organizations/{org_id}/uploads) or SFTP.
Complete Raw Files
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
Request body: application/json, RawFilesCompleteRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
408 | Request Timeout |
413 | Request Entity Too Large |
asset-types
GET /v2/asset-types
List Asset Types
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
GET /v2/asset-types/{slug}
Get Asset Type
| Parameter | In | Type | Required |
|---|---|---|---|
slug | path | string | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
domains
GET /v2/domains
List Domains
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
content-tags
GET /v2/content-tags
List Content Tags
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
inventory-tags
GET /v2/inventory-tags
List Inventory Tags
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
project-opportunities
GET /v2/project-opportunities/bids/mine
Retired: DataDrop has no project opportunities: the list is always empty and every id is not found.
List My Bids
| Parameter | In | Type | Required |
|---|---|---|---|
offset | query | integer | no |
limit | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/project-opportunities/{opportunity_id}
Retired: DataDrop has no project opportunities: the list is always empty and every id is not found.
Get Project Opportunity
| Parameter | In | Type | Required |
|---|---|---|---|
opportunity_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
notifications
GET /v2/vendor/notifications
List Notifications
| Parameter | In | Type | Required |
|---|---|---|---|
view | query | NotificationView | no |
limit | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
vendor
POST /v2/vendor/uploads/grants/{token}
Not supported: files are sent through an upload link instead: each file declared with its SHA-256 (POST /v2/upload-links/{token}), its parts sent through the API.
Reserve Upload Grant
| Parameter | In | Type | Required |
|---|---|---|---|
token | path | string | yes |
Request body: application/json, StagedUploadCreateRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
410 | Gone |
POST /v2/vendor/uploads/grants/{token}/parts
Not supported: files are sent through an upload link instead: each file declared with its SHA-256 (POST /v2/upload-links/{token}), its parts sent through the API.
Presign Upload Grant Parts
| Parameter | In | Type | Required |
|---|---|---|---|
token | path | string | yes |
Request body: application/json, StagedUploadPartsRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
410 | Gone |
POST /v2/vendor/uploads/grants/{token}/complete
Not supported: files are sent through an upload link instead: each file declared with its SHA-256 (POST /v2/upload-links/{token}), its parts sent through the API.
Complete Upload Grant
| Parameter | In | Type | Required |
|---|---|---|---|
token | path | string | yes |
Request body: application/json, StagedUploadCompleteRequest.
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
410 | Gone |
POST /v2/vendor/connectors/{provider}/imports
Retired: the Jira and Confluence connectors are not available on DataDrop: an import or an attach is refused naming this, and a detach is not found.
Create Import
| Parameter | In | Type | Required |
|---|---|---|---|
provider | path | string | yes |
Request body: application/json, ConnectorImportRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/vendor/connectors/{provider}/assets/{asset_id}/data
Retired: the Jira and Confluence connectors are not available on DataDrop: an import or an attach is refused naming this, and a detach is not found.
Attach Connector Data
| Parameter | In | Type | Required |
|---|---|---|---|
provider | path | string | yes |
asset_id | path | string (uuid) | yes |
Request body: application/json, AssetConnectorDataRequest or AssetUploadDataRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
DELETE /v2/vendor/connectors/{provider}/assets/{asset_id}/data
Retired: the Jira and Confluence connectors are not available on DataDrop: an import or an attach is refused naming this, and a detach is not found.
Detach Connector Data
| Parameter | In | Type | Required |
|---|---|---|---|
provider | path | string | yes |
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
204 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
estimations
GET /v2/estimations
List Estimations
| Parameter | In | Type | Required |
|---|---|---|---|
limit | query | integer | no |
offset | query | integer | no |
filter | query | array of string or null | no |
sort | query | string or null | no |
sort_direction | query | string | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/estimations
Not supported: an API key cannot use a person's code-host connection; estimate a connected repository in the web app, or an asset you have added by its id (POST /v2/estimations/assets/{asset_id}).
Create Estimations
Request body: application/json, EstimationCreateRequest.
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
POST /v2/estimations/assets/{asset_id}
Estimate Asset
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
201 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/estimations/summary
Estimation Summary
| Parameter | In | Type | Required |
|---|---|---|---|
filter | query | array of string or null | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/estimations/latest
Latest Asset Estimations
| Parameter | In | Type | Required |
|---|---|---|---|
asset_id | query | array of string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/estimations/{estimation_id}
Get Estimation
| Parameter | In | Type | Required |
|---|---|---|---|
estimation_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
opportunities
GET /v2/opportunities
List Opportunities
| Parameter | In | Type | Required |
|---|---|---|---|
query | query | string or null | no |
tags | query | array of string or null | no |
asset_types | query | array of string or null | no |
max_budget | query | number or null | no |
budget_unit | query | string or null | no |
sort | query | string | no |
offset | query | integer | no |
limit | query | integer | no |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
GET /v2/opportunities/{opportunity_id}
Get Opportunity
| Parameter | In | Type | Required |
|---|---|---|---|
opportunity_id | path | string (uuid) | yes |
| Status | Meaning |
|---|---|
200 | Successful Response |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
503 | Service Unavailable. When the service is busy: the detail "The service is busy: nothing was changed. Try again in a few seconds." and a `Retry-After` header in seconds; send the same request again. This shape has no `reason` field: busy is told from another 503 by that detail. |
422 | Unprocessable Entity |
Not available yet
GET /v2/wallet
Not available yet: arrives with Ember Data's credit balance.