Skip to content
Skyfish API

Overview

Skyfish API 0.1.0

Section titled “Skyfish API 0.1.0”

Documentation for the skyfish api

Information

  • OpenAPI version: 3.0.1

Operations

Section titled “Operations”
POST
/authenticate/userpasshmac
POST
/authenticate/userpass/reset
GET
/authenticate/simpletoken/{token_string}
GET
/search
GET
/search/colourbox/download
GET
/media/{id}
GET
/media/{id}/metadata
POST
/media/{id}/metadata
GET
/media/{id}/metadata/expiration_date
POST
/media/{id}/metadata/expiration_date
DELETE
/media/{id}/metadata/expiration_date
GET
/media/{id}/folders
POST
/media/{id}/folders
POST
/media/{id}/folder/{folderId}
DELETE
/media/{id}/folder/{folderId}
POST
/media/{id}/folder/{folderId}/move_to_trash
GET
/media/{id}/version
GET
/media/{id}/tags
GET
/folder
POST
/folder
GET
/folder/{folderId}
POST
/folder/{folderId}
DELETE
/folder/{folderId}
POST
/folder/{folderId}/purge
POST
/folder/{folderId}/move_to_trash
GET
/clique
POST
/clique
POST
/clique/{clique_id}
DELETE
/clique/{clique_id}
GET
/clique/{clique_id}/member
POST
/clique/{clique_id}/member/{user_id}
DELETE
/clique/{clique_id}/member/{user_id}
GET
/clique/{clique_id}/folder
POST
/clique/{clique_id}/folder/{folderId}
DELETE
/clique/{clique_id}/folder/{folderId}
GET
/media/{id}/download
GET
/media/{id}/download_location
GET
/media/{id}/download/{size}
GET
/media/{id}/download_location/{size}
GET
/folder/{folderId}/download
GET
/folder/{folderId}/download_location
POST
/folder/{folderId}/zip-file
GET
/zip-file/f/{id}
POST
/upload/register
GET
/company/{id}/users
GET
/company/{id}/folders
GET
/company/{id}/apikeys
POST
/company/{id}/apikeys
PATCH
/company/{id}/apikeys/{apiKeyId}
GET
/company/{id}/apiendpoint
POST
/user
GET
/user/{user_id}/folders
GET
/user/{user_id}/profileimage
POST
/user/{user_id}/profileimage
GET
/user/{user_id}/profileimage/{size}
GET
/user/{user_id}/clique
DELETE
/user/{user_id}/company/{company_id}/orbits/{orbits}
GET
/user/{user_id}/diskusage
GET
/company/{id}/diskusage
POST
/signup

Authentication

Section titled “Authentication”

simple_token

Section titled “simple_token”

Token-based authorization. Get an auth-token from POST /authenticate/userpasshmac and send it on every request:

Authorization: CBX-SIMPLE-TOKEN Token=<token>

Security scheme type: apiKey

Header parameter name: Authorization

url_token

Section titled “url_token”

For embeddable download URLs: the base64 encoding of the value you would otherwise send in the Authorization header. See URL authorization.

Security scheme type: apiKey

Query parameter name: Authorization