Introduction to the Meta API 

The Meta API provides programmatic access to your Kloudless developer account and information associated with it, such as applications.

You will need your Kloudless Meta token to make requests to this API. This key is different from your individual application API Keys, and can be obtained on your Account Settings page.

You can test requests via the ‘Applications’ endpoints towards the bottom of the API Explorer page.

The Meta API has the API type meta which is the Kloudless API itself. The meta API has the following available object types representing the objects described below:

• kloudless_id: An encoded ID representing an object accessible via the Kloudless API.

• developer: A Developer who has signed up at the Kloudless Developer Portal.

• application: An Application created by a Kloudless Developer.

• apikey: An API Key belonging to an Application.

• trusted_domain: A Trusted Domain configured for an Application.

• webhook: A Webhook configured for an Application.

• service_key: A custom OAuth Credential configured for an Application.

• redirect_uri: A Redirect URL whitelisted for an Application’s OAuth flow.

• fe_upload_location: An Upload Location whitelisted for an Application’s use of the File Explorer.

• usage_report: A summary of usage over a period of time.

• license: A Kloudless Enterprise license associated with the developer’s account.

• invoice: Invoice, received from Kloudless.

• analytics_api_request: Statistics describing an individual API request.

Authorization 

A developer can use an Authorization header to authorize requests for the Kloudless API with an Meta token:

Authorization: Bearer {token: string}

Here is how you can make a request using cURL:

curl -L -H 'Authorization: Bearer [TOKEN]' \
    https://api.kloudless.com/v1/[RESOURCE]

Here are some example requests:

curl -L -H 'Authorization: Bearer isgqXuDfLBOhcZzf7cO93T' \
    https://api.kloudless.com/v1/meta/applications

Developers 

Kloudless Developers have the attributes below:

• id Unique identifier for this developer.

• first_name The developer’s first name.

• last_name The developer’s last name.

• email The developer’s email address.

• organization The ID of the Kloudless Enterprise organization the developer belongs to.

• organization_name The name of the organization with the ID in the organization field.

• company The developer’s company.

• date_joined ISO 8601 timestamp indicating when the developer signed up at the Kloudless developer portal.

• admin Grants admin access and all permissions in the Kloudless Admin Portal without specifically assigning them to this developer.

• type Will always be developer.

• api Will always be meta

List Developers 

Retrieve a Developer 

Update a Developer 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -XPATCH -d '{"first_name": "J", "last_name": "B"}' \
    'https://api.kloudless.com/v1/meta/developers/4'

Applications 

Kloudless Applications have the attributes below:

• id Unique identifier for this application. Also known as the App ID.

• name The application’s name. Will be displayed to a user connecting an account to the application.

• description A description of the application.

• logo_url A URL at which an image containing the logo for the application is available. The URL will be used to display the logo to the user when using Kloudless UI components.

• active Whether the application is active or not. Deleted applications will not show up via the API and do not count as ‘inactive’.

• implicit_grant_enabled If True, allows OAuth 2.0 Implicit Grant flow for this application. Defaults to False.

• recent_enabled If True, collects data on recent activity in accounts, such as information on recently modified files. Defaults to False.

• events_enabled If True, collects event data for accounts. Defaults to False.

• internal_use Internal Development: This indicates that accounts connected to this application are only used internally for development, testing, and similar purposes. This enables Kloudless to waive usage fees for these accounts.

• created ISO 8601 timestamp indicating when the application object was created.

• modified ISO 8601 timestamp indicating when the application object was modified.

• type Will always be application.

• api Will always be meta

List Applications 

Create an application 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -d '{"name": "Test App 1", "description": "A test application."}' \
    'https://api.kloudless.com/v1/meta/applications/'

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -d '{"name": "Test App 2", "source": "wSPk9y5D7p5o87k0ACGKxR"}' \
    'https://api.kloudless.com/v1/meta/applications/'

Retrieve an Application 

Update an Application 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -XPATCH -d '{"description": "A better test application."}' \
    'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR'

Delete an Application 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR'

API Keys 

Kloudless API Keys have the attributes below:

• key The API Key. This is unique across all applications.

• created ISO 8601 timestamp indicating when the API Key object was created.

• modified ISO 8601 timestamp indicating when the API Key object was modified.

• type Will always be apikey.

• api Will always be meta.

List API Keys 

Create an API Key 

curl -XPOST -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/apikeys/'

Delete an API Key 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR/apikeys/80OdF5hXzkNqEs9DHRkiA1EXz1pbF4'

Trusted Domains 

UI Tools such as the Authenticator and File Explorer JS libraries allow users to connect accounts. Bearer tokens for accounts connected can be returned to your application’s web page in the event callback if the domain of the web page is a Trusted Domain. This allows further API requests to be made from the web page using the bearer tokens.

Kloudless Trusted Domains have the attributes below:

• id The trusted domain id. This is unique across all applications.

• domain The trusted domain itself. Wildcards are permitted for subdomain names. A domain of the form *.domain.com will trust all subdomains, such as x.domain.com and y.x.domain.com but not domain.com itself.

• created ISO 8601 timestamp indicating when the Trusted Domain object was created.

• modified ISO 8601 timestamp indicating when the Trusted Domain object was modified.

• type Will always be apikey.

• api Will always be meta.

List Trusted Domains 

Create a Trusted Domain 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -XPOST -d '{"domain": "*.my-domain.com"}' \
    'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/trusted_domains/'

Retrieve a Trusted Domain 

Delete a Trusted Domain 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR/trusted_domains/1'

WebHooks 

Kloudless WebHooks have the attributes below:

• id The WebHook ID. This is unique across all applications.

• url The WebHook URL. See the Activity API docs for more information.

• created ISO 8601 timestamp indicating when the WebHook object was created.

• modified ISO 8601 timestamp indicating when the WebHook object was modified.

• type Will always be webhook.

• api Will always be meta.

• body_format This indicates the content type of the webhook request’s body. Here are the supported values:

  • json (default): The Content-Type will be application/json.
  • form: This is a legacy format for Webhooks created prior to Sept 2019. The content type will be application/x-www-form-urlencoded.
  • eventbridge: This indicates an Amazon EventBridge endpoint.

• extra A read-only JSON object with additional data about the webhook.

List WebHooks 

Create a WebHook 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -XPOST -d '{"url": "http://localhost:5000"}' \
    'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/webhooks'

Retrieve a WebHook 

Delete a WebHook 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR/webhooks/100'

Service Keys 

Kloudless Service Keys are used when configuring OAuth credentials to authenticate users connecting a certain account. They have the attributes below:

• id Unique identifier for this Service Key.

• application ID of the Kloudless Application that this key is configured for.

• service_name Human-friendly name of the Service this key is for. e.g. Google Drive.

• service The key’s service identifier. e.g. gdrive.

• key Service Key ID. Usually the OAuth Client ID.

• secret Serivice key’s secret. This attribite is write-only. Usually corresponds to the OAuth Client Secret.

• secondary_key Secondary key for the service. Purpose varies by Service, but is usually a secondary OAuth Client ID if needed.

• secondary_secret Secret for the secondary key. This attribute is write-only. Corresponds to an OAuth Client Secret if needed, although its purpose varies by Service.

• secondary_id The Secondary ID. Purpose varies by Service.

• resource Set an optional domain here to ensure that this Service Key is only used when authenticating accounts connecting to this domain. End-users must first see a preliminary authentication screen prompting them to enter their email address for this to take effect.

• deactivation ISO 8601 timestamp indicating when the service key is deactivated.

• admin Whether this is an admin service key. Defaults to false.

• created ISO 8601 timestamp indicating when the object was created.

• modified ISO 8601 timestamp indicating when the object was modified.

• type Will always be service_key.

• api Will always be meta.

List Service Keys 

Create a Service Key 

curl -X POST \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' -d '{ \
   "service": "gdrive", \
   "key": "test-key" \
 }' 'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/service_keys/'

Retrieve a Service Key 

Update a Service Key 

curl -X PATCH \
     -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
     -H 'Content-Type: application/json' \
     -d '{"key": "new key"}' \
     'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/service_keys/10/'

Delete a Service Key 

curl -XDELETE \
    -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR/service_keys/10/'

Redirect URIs 

Kloudless Redirect URIs have the attributes below:

• id Unique identifier for this Redirect URI.

• application Kloudless Application ID.

• uri Redirect URL.

• created ISO 8601 timestamp indicating when the object was created.

• modified ISO 8601 timestamp indicating when the object was modified.

• type Will always be redirect_uri.

• api Will always be meta

List Redirect URIs 

Create a Redirect URI 

curl -X POST \
   -H 'Content-Type: application/json' \
   -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
   -d '{"uri": "root"}' \
   'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/redirect_uris/'

Retrieve a Redirect URI 

Delete a Redirect URI 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR/redirect_uris/3/'

File Explorer Upload Locations 

Kloudless File Explorer Upload Locations (or FE Upload Locations) have the attributes below:

• id Unique identifier for the FE Upload Location.

• application Kloudless Application ID.

• account ID of the Kloudless Account accessed by the API request.

• folder_id ID of the folder.

• folder_name Name of the folder.

• allow_overwrites If true, user-uploaded content with the same name will overwrite each other. Normally, files are renamed if they conflict and are being uploaded to the same folder. Do not set this to true unless a specific sub-folder is being specified, or deliberately want to overwrite content with the same name regardless of origin. This option defaults to false.

• allow_specific_subfolder If true, the File Explorer can be configured to upload files to either the root folder directly or any specified sub-folder. Otherwise, files will be uploaded to a randomly named sub-folder in the Upload Location to ensure uniqueness. The File Explorer’s upload_location_folder configuration option should contain the ID of the folder as usual, except it can be the configured Upload Location or any sub-folder rather than only the Upload Location. If enabling this behavior, ensure users only have access to IDs of folders their content should be uploaded to. Otherwise, malicious users could upload content to unexpected folders. This option defaults to false.

• created ISO 8601 timestamp indicating when the object was created.

• modified ISO 8601 timestamp indicating when the object was modified.

• type Will always be fe_upload_location.

• api Will always be meta.

List File Explorer Upload Locations 

Create a File Explorer Upload Location 

curl -X POST \
   -H 'Content-Type: application/json' \
   -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' -d '{ \
   "account": "12933", \
   "allow_specific_subfolder": true, \
   "allow_overwrites": true, \
   "folder_id": "root", \
   "folder_name": "Test Folder Name" \
 }' 'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/fe_upload_locations/'

Retrieve a File Explorer Upload Location 

Update a File Explorer Upload Location 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -XPATCH -d '{"folder_name": "Test Folder Name 2"}' \
    'https://api.kloudless.com/v1/meta/applications/wSPk9y5D7p5o87k0ACGKxR/fe_upload_locations/5/'

Delete a File Explorer Upload Location 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/applications/koiR71rFLPTdld9N-YUR/fe_upload_locations/3/'

Usage Reports 

Kloudless Usage Reports can be retrieved via this endpoint. Each object describes the application’s API request statistics during a certain time period beginning at from (inclusive) and ending at until (non-inclusive): [from, until). An object has the attributes below:

• application Kloudless Application ID.

• from ISO 8601 timestamp indicating the start of the time period this record contains information on.

• until ISO 8601 timestamp indicating the end of time period this record contains information on.

• bandwidth Bandwidth consumed by the application during the time period.

• active_accounts Number of accounts accessed by the application during the time period.

• requests Number of API Requests processed by the application during the time period.

• created ISO 8601 timestamp indicating when the Usage Report record was created.

• type Will always be usage_report.

• api Will always be meta.

List Usage Reports 

Invoices 

Kloudless Invoices can be retrieved via this endpoint. Each object describes an invoice received from Kloudless. An object has the attributes below:

• created ISO 8601 timestamp indicating when the invoice was created.

• amount Total amount of the invoice in USD.

• description The invoice’s description.

• status The invoice’s status. Can be one of paid or unpaid.

• pdf_url A URL to download a PDF representation of the invoice from.

• url A URL to a web page with invoice details and an option to pay the invoice.

• type Will always be invoice.

• api Will always be meta.

List Invoices 

API Request Analytics 

Statistics for individual Kloudless API Requests can be retrieved via these endpoints. Each object contains information describing an individual API request and has the attributes below:

• application Kloudless Application ID.

• account ID of the Kloudless Account accessed by the API request.

• duration Duration of the API Request in seconds.

• ip IP address the API request originated from.

• method HTTP method used in the API Request.

• path Path component of the URL accessed.

• query Query component of the URL accessed.

• request_id Unique ID of the API Request.

• rx_bytes Bytes in the HTTP request received by the Kloudless server.

• tx_bytes Bytes in the HTTP response sent by the Kloudless server.

• start_time ISO 8601 timestamp indicating when the API request started.

• created ISO 8601 timestamp indicating when the API request was recorded.

• status HTTP response status code.

• type Will always be analytics_api_request.

• api Will always be meta.

List API Request Analytics 

Licenses 

Kloudless License objects represent individual licenses used to run Kloudless Enterprise Docker containers and virtual machines.

Kloudless Licenses have the attributes below:

• id The license identifier. This is unique across all applications.

• org_id The organization identifier. This is unique across all applications.

• org_name The organization name. This is the human-readable name of the Organization that owns this license.

• description Description of the license’s purpose and any notes.

• release Kloudless Enterprise release channel. e.g. prod for production releases and test for QA releases.

• active A boolean value indicating whether this license is active.

• expiry ISO 8601 timestamp for when the license expires.

• scope A string delimited by whitespaces indicating the scope of this license.

• apis_available A list of Kloudless unified APIs available

• services_available A list of third-party service IDs corresponding to connectors supported by this license. An empty list implies all services are supported.

• support_clustering A boolean value indicating whether clustering is supported.

• created ISO 8601 timestamp indicating when the license was created.

• modified ISO 8601 timestamp indicating when the license was last updated.

• type Will always be license.

• api Will always be meta.

List Licenses 

Create a License 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' -X POST \
    -d '{"id": 1, "description": "New license for kloudless development."}' \
    'https://api.kloudless.com/v1/meta/licenses'

Retrieve a License 

Download a License 

curl -L -H 'Authorization: Bearer [TOKEN]' \
    'https://api.kloudless.com/v1/meta/licenses/1/contents'

Update a License 

curl -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -H 'Content-Type: application/json' \
    -XPATCH -d '{"description": "New license description."}' \
    'https://api.kloudless.com/v1/meta/licenses/4'

Delete a License 

curl -L -H 'Authorization: Bearer S4i5EG5ViEAVmMaCilB5' \
    -XDELETE 'https://api.kloudless.com/v1/meta/licenses/1'

Other Information 

For more information such as Error Codes, SDKs and Support, please refer to the Core API docs.