Provider File

View as Markdown

GetGET /api/2.0/marketplace-provider/files/{file_id}ListGET /api/2.0/marketplace-provider/filesCreatePOST /api/2.0/marketplace-provider/filesDeleteDELETE /api/2.0/marketplace-provider/files/{file_id}

FileInfo object

idstring

marketplace_file_typestring

Values: PROVIDER_ICON, EMBEDDED_NOTEBOOK, APP

file_parentobject

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values: PROVIDER, LISTING, LISTING_RESOURCE

mime_typestring

download_linkstring

created_atint64

updated_atint64

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Values: FILE_STATUS_PUBLISHED, FILE_STATUS_STAGING, FILE_STATUS_SANITIZING, FILE_STATUS_SANITIZATION_FAILED

status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

View as Markdown

The FileInfo object

{
  "id": "string",
  "marketplace_file_type": "string",
  "file_parent": {
    "parent_id": "string",
    "file_parent_type": "string"
  },
  "mime_type": "string",
  "download_link": "string",
  "created_at": 0,
  "updated_at": 0,
  "display_name": "string",
  "status": "string",
  "status_message": "string"
}

Get

GET /api/2.0/marketplace-provider/files/{file_id}

Get a file

API scopes: marketplace

Parameters

file_idstringpath

Response

file_infoobject

Show child attributesHide child attributes

idstring

marketplace_file_typestring

Values: PROVIDER_ICON, EMBEDDED_NOTEBOOK, APP

file_parentobject

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values: PROVIDER, LISTING, LISTING_RESOURCE

mime_typestring

download_linkstring

created_atint64

updated_atint64

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Values: FILE_STATUS_PUBLISHED, FILE_STATUS_STAGING, FILE_STATUS_SANITIZING, FILE_STATUS_SANITIZATION_FAILED

status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

View as Markdown

Response

{
  "file_info": {
    "id": "string",
    "marketplace_file_type": "string",
    "file_parent": {},
    "mime_type": "string",
    "download_link": "string",
    "created_at": 0,
    "updated_at": 0,
    "display_name": "string",
    "status": "string",
    "status_message": "string"
  }
}

List

GET /api/2.0/marketplace-provider/files

List files attached to a parent entity.

API scopes: marketplace

Parameters

file_parentobjectquery

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values: PROVIDER, LISTING, LISTING_RESOURCE

page_tokenstringquery

page_sizeint32query

Response

Returns a list of FileInfo objects.

View as Markdown

Response

{
  "file_infos": [
    {
      "id": "string",
      "marketplace_file_type": "string",
      "file_parent": {},
      "mime_type": "string",
      "download_link": "string",
      "created_at": 0,
      "updated_at": 0,
      "display_name": "string",
      "status": "string",
      "status_message": "string"
    }
  ],
  "next_page_token": "string"
}

Create

POST /api/2.0/marketplace-provider/files

Create a file. Currently, only provider icons and attached notebooks are supported.

API scopes: marketplace

Request body

file_parentobject

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values: PROVIDER, LISTING, LISTING_RESOURCE

marketplace_file_typestring

Values: PROVIDER_ICON, EMBEDDED_NOTEBOOK, APP

mime_typestring

display_namestring

Response

upload_urlstring

Pre-signed POST URL to blob storage

file_infoobject

Show child attributesHide child attributes

idstring

marketplace_file_typestring

Values: PROVIDER_ICON, EMBEDDED_NOTEBOOK, APP

file_parentobject

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values: PROVIDER, LISTING, LISTING_RESOURCE

mime_typestring

download_linkstring

created_atint64

updated_atint64

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Values: FILE_STATUS_PUBLISHED, FILE_STATUS_STAGING, FILE_STATUS_SANITIZING, FILE_STATUS_SANITIZATION_FAILED

status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

View as Markdown

Request

{
  "file_parent": {
    "parent_id": "string",
    "file_parent_type": "string"
  },
  "marketplace_file_type": "string",
  "mime_type": "string",
  "display_name": "string"
}

Response

{
  "upload_url": "string",
  "file_info": {
    "id": "string",
    "marketplace_file_type": "string",
    "file_parent": {},
    "mime_type": "string",
    "download_link": "string",
    "created_at": 0,
    "updated_at": 0,
    "display_name": "string",
    "status": "string",
    "status_message": "string"
  }
}

Delete

DELETE /api/2.0/marketplace-provider/files/{file_id}

Delete a file

API scopes: marketplace

Parameters

file_idstringpath

View as Markdown

Response

{}