Sign Up Free
Log In

Management

Overview

The Management API allows you to manage your applications programmatically. It’s a RESTful API that uses standard HTTP features, including HTTP authentication and methods, which are understood by any HTTP client.

Authentication

The Management API uses JSON Web Tokens (JWT) to authorize requests. For details on how to get and use tokens, see the Obtaining Tokens section.

All API requests must be made over HTTPS and include a JWT in the Authorization header as a Bearer token.

curl -X GET \
    https://management.filestackapi.com/apps \
    -H "Authorization: Bearer <token>" \
    -H "API-Version: 1.0.0"

Error Handling

The Management API uses conventional HTTP response codes to indicate the success or failure of a request. In general, codes in the 2xx range indicate success, 4xx codes indicate a client-side error (e.g., invalid parameters), and 5xx codes indicate a server-side error on Filestack’s end.

Common Error Codes
Code Description
400 Bad Request: The request was unacceptable, often due to a missing or invalid parameter. The error message will provide more detail.
401 Unauthorized: Authentication failed. This can happen if the client_id or secret_key are invalid when obtaining a token.
404 Not Found: The requested resource could not be found.
405 Method Not Allowed: The request method is not supported for this resource.
429 Too Many Requests: Your application is being rate-limited.
503 Service Unavailable: A server error occurred. Please try again later.

Versioning

We release new, dated versions for backward-incompatible changes. Requests default to your account’s API settings, but you can override this by sending an API-Version header.

To set the API version on a specific request, send API-Version header.

curl -X GET \
    https://management.filestackapi.com/apps \
    -H "API-Version: 0.0.1" \
    -u "<client_id>:<secret_key>"

Date Format

All timestamps in the Management API are formatted as RFC 3339 strings (e.g., 2008-09-08T22:47:31-07:00).

API Reference

Obtain a Token

Endpoint

POST /auth

Example Request

curl -X POST \
    https://management.filestackapi.com/auth \
    -u "<client_id>:<secret_key>" \
    -H "API-Version: 0.0.1"

Returns

Returns A successful request returns a 200 OK response with the JWT.

{
    "token": "eyJhbG2.eyJpc3MiOiJ.8sRFwN8kg66"
}

Notes

The received token must be included as a Bearer token in the Authorization header for all subsequent requests.

curl -X GET \
    https://management.filestackapi.com/apps \
    -H "Authorization: Bearer eyJhbG2.eyJpc3MiOiJ.8sRFwN8kg66"

Each token is valid for 60 minutes. When it expires, obtain a new one using this endpoint. There are no refresh tokens.

Create an Application

Endpoint

POST /apps

Example Request

curl -X POST \
    https://management.filestackapi.com/auth \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "MyApp1",
      "url": "http://myapp1.com",
      "parent_apikey": "AXXXDCPRVns4JP2ooooz",
      "limits": {
        "creations": 100,
        "transformations": 100,
        "transfer": 100
      } 
    }'

Parameters

Parameter Type Description
name STRING Name of your application (optional)
url STRING URL of your application (optional)
parent_apikey STRING APIKEY of the parent application (optional)
limits.creations INTEGER Limit for created files (applied only when parent_apikey is present)
limits.transformations INTEGER Limit for file transformations (applied only when parent_apikey is present)
limits.transfer INTEGER Transfer limit in bytes (applied only when parent_apikey is present)

Returns

A successful request returns a 201 Created response with the new application object.

{
    "apikey": "A2XA2sDCPRVns4JP2o7imz",
    "url": http://myapp1.com,
    "name": "MyApp1",
    "parent_apikey": "AXXXDCPRVns4JP2ooooz",
    "storages": {},
    "limits": {
      "creations": 100,
      "transformations": 100,
      "transfer": 100
    },
    "created_at": "2008-09-08T22:47:31-07:00"
}
Parameter Type Description
apikey STRING API key for your new application.
name STRING Name of your application.
url STRING URL of your application.
parent_apikey STRING API key of parent application (if provided)
limits.creations INTEGER Limit for created files
limits.transformations INTEGER Limit for file transformations
limits.transfer INTEGER Transfer limit in bytes
created_at TIMESTAMP Application creation date.

List Applications

Endpoint

GET /apps

Example Request

curl -X GET \
    https://management.filestackapi.com/apps?limit=2&offset=20 \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Query Parameters

Parameter Type Default
Limit INTEGER 10
Offset INTEGER 0

Returns

A successful request returns a 200 OK response with a paginated list of applications.

{
    "limit": 2,
    "offset": 20,
    "total": 2143,
    "apps": [
      {
        "apikey": "A2XA2sDLKJHns4JP2o7imz",
        "url": "http://myapp1.com",
        "name": "MyApp1",
        "parent_apikey": "B2XA2sDCPRVns4JP2o7yhn",
        "created_at": "2008-09-08T22:47:31-07:00",
        "storages": {
          "S3": {
            "s3_access_id": "ZXC*******",
            "s3_secret_key": "abc*******",
            "s3_bucket": "my_bucket",
            "encrypted": true,
            "reduced_redundancy": false
          }
        }
      },
      {
        "apikey": "B2XA2sDCPRVns4JP2o7yhn",
        "url": "http://myapp2.com",
        "name": "MyApp2",
        "created_at": "2011-10-23T10:23:33-07:00",
        "storages": {},
      }
    ]
}
Parameter Type Description
limit INTEGER Given limit.
offset INTEGER Given offset.
total INTEGER Total number of applications.
apps[].apikey STRING Application API key.
apps[].name STRING Name of the application.
apps[].url STRING URL of the application.
apps[].created_at TIMESTAMP Application creation date.
apps[].storages JSON Storages defined for specific application

Get an Application

Endpoint

GET /apps/<apikey>

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey> \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A successful request returns a 200 OK response with the application object.

{
    "apikey": "A2XA2sDCPRVns4JP2o7imz",
    "url": "http://myapp1.com",
    "name": "MyApp1",
    "created_at": "2008-09-08T22:47:31-07:00",
    "storages": {
      "S3": {
        "s3_access_id": "ZXC*******",
        "s3_secret_key": "abc*******",
        "s3_bucket": "my_bucket",
        "encrypted": true,
        "reduced_redundancy": false
      }      
    }      
}
Parameter Type Description
apikey STRING API key for your new application.
name STRING Name of your application.
url STRING URL of your application.
created_at TIMESTAMP Application creation date.
storages JSON Storages defined for specific application

Update an Application

Endpoint

POST /apps/<apikey>

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey> \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '{
      "name": "new-name",
      "url": "https://new.url",
      "limits": {
        "creations": 200,
        "transformations": 300,
        "transfer": 400
      }
    }'

Parameters

Parameter Type Description
name STRING Name of your application (optional)
url STRING URL of your application (optional)
limits.creations INTEGER Limit for created files (allowed only when parent_apikey was set for application)
limits.transformations INTEGER Limit for file transformations (allowed only when parent_apikey was set for application)
limits.transfer INTEGER Transfer limit in bytes (allowed only when parent_apikey was set for application)

Returns

A successful update returns an empty 204 No Content response. If the application with the specified apikey does not exist, a 404 Not Found response is returned.

Delete an Application

Endpoint

DELETE /apps/<apikey>

Example Request

curl -X DELETE \
    https://management.filestackapi.com/apps/<apikey> \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A successful update returns an empty 204 No Content response. If the application with the specified apikey does not exist, a 404 Not Found response is returned.

Get Security Settings

Endpoint

GET /apps/<apikey>/security

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/security \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with following output:
{
    "enabled": false,
    "secret": "5HHGLM123456789XXXZRUUEMLM",    
}

Modify Security Settings

Endpoint

POST /apps/<apikey>/security

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/security \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "enabled": true,
      "reset_secret": true
    }'

Request Parameters

Parameter Type Description
enabled BOOL Enables/disables app security
reset_secret BOOL If true, new app security secret will be generated

Returns

A 200 OK response will be returned with following output:
{
    "enabled": true,
    "secret": "SOMENEWSECRET78XZRUUEMLM",    
}

Add S3 Storage

Endpoint

POST /apps/<apikey>/storages/S3

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/storages/S3 \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "s3_access_id": "<s3_access_id>", 
      "s3_secret_key": "<s3_secret_key>", 
      "s3_bucket": "my_bucket",
      "s3_region": "eu-west-1",
      "encrypted": false,
      "reduced_redundancy": false
    }'

Parameters

Parameter Type Description
s3_access_id STRING AWS Access Key ID with access to your bucket.
s3_secret_key STRING AWS Secret Access Key.
s3_bucket STRING Default bucket name.
s3_region STRING Region of your bucket
Encrypted BOOL Is encryption enabled in your bucket? (optional, default false)
Reduced_redundancy BOOL Is RRS enabled in your bucket? (optional, default false)

Returns

A successful update returns an empty 204 No Content response. If the application with the specified apikey does not exist, a 404 Not Found response is returned.

Notes

We do not validate credentials during this call. To verify them, use the Test Storage Credentials endpoint after adding them.

Add Google Cloud Storage Credentials

Endpoint

POST /apps/<apikey>/storages/gcs

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/storages/gcs \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "gcs_json": "{\"private_key_id\": ... }", 
      "gcs_project_id": "<gcs_project_id>", 
      "gcs_bucket": "my_gcs_bucket"
    }'

Parameters

Parameter Type Description
gcs_json STRING JSON string with Google Storage credentials
gcs_project_id STRING Google Project Id
gcs_bucket STRING Default bucket name

Returns

A successful update returns an empty 204 No Content response. If the application with the specified apikey does not exist, a 404 Not Found response is returned.

Notes

We do not validate credentials during this call. To verify them, use the Test Storage Credentials endpoint after adding them.

Add Azure Storage Credentials

Endpoint

POST /apps/<apikey>/storages/azure

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/storages/azure \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "account_name": "<azure_account_name>",
      "access_key": "<azure_access_key>",
      "container": "<azure_container>"
    }'

Parameters

Parameter Type Description
account_name STRING Azure account name
access_key STRING Azure access key
container STRING Default Azure container

Returns

A successful update returns an empty 204 No Content response. If the application with the specified apikey does not exist, a 404 Not Found response is returned.

Notes

We do not validate credentials during this call. To verify them, use the Test Storage Credentials endpoint after adding them.

Add Rackspace Storage Credentials

Endpoint

POST /apps/<apikey>/storages/rackspace

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/storages/rackspace \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "username": "<rackspace_name>",
      "key": "<rackspace_key>",
      "container": "<rackspace_contianer>"
    }'

Parameters

Parameter Type Description
username STRING Rackspace username
key STRING Rackspace key
container STRING Default Rackspace container

Returns

A successful update returns an empty 204 No Content response. If the application with the specified apikey does not exist, a 404 Not Found response is returned.

Notes

We do not validate credentials during this call. To verify them, use the Test Storage Credentials endpoint after adding them.

Test Storage Credentials

Endpoint

POST /apps/<apikey>/storages/<storage-type>/test
Available storage types: S3, gcs (Google Cloud Storage), dropbox, rackspace, azure

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/storages/S3/test \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response should be returned. If storage credentials are valid, response body should the following JSON body: {"success": true}. If for some reason the test fails, response JSON will contain an error message: {"message": "[uuid=E8ADED835D5E49BC] Invalid S3 credentials or permissions.", "success": false}

Notes

This endpoint will always return a 200 OK status code if the API call is successful, even if the storage credentials test fails. You must inspect the success field in the JSON response body to determine the actual outcome of the test. An invalid request to the endpoint itself (e.g., bad token) will result in a standard 4xx or 5xx error.

List Webhooks

Endpoint

GET /apps/<apikey>/webhooks

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/webhooks \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with list of applications in JSON structure:
{
    "total": 4,
    "webhooks": [
      {
        "type": "delete",
        "id": "3869",
        "url": "https://url.one"
      },
      {
        "type": "export",
        "id": "3854",
        "url": "http://url.two/new"
      },
      {
        "type": "video_converse",
        "id": "3853",
        "url": "http://another.in/foo"
      },
      {
        "type": "upload",
        "id": "3806",
        "url": "http://foo.bar/101"
      }
    ]   
}

Add a Webhook

Endpoint

POST /apps/<apikey>/webhooks

Get list of webhooks defined for given application

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/webhooks \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "url": "https://some.url",
      "type": "<webhook_type>"
    }'

Request Parameters

Parameter Type Description
url String Webhook URL
type String The event type that triggers the webhook. Available types:
  • upload
  • delete
  • converse
  • video_converse
  • overwrite
  • dialog
  • export

Returns

An 201 Created response will be returned with list of applications in JSON structure:

{
    "type": "delete",
    "id": 3869,
    "url": "https://url.one",    
}

Update a Webhook

Endpoint

POST /apps/<apikey>/webhooks/<webhook_id>
Update selected webhook

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/webhooks/<webhook_id> \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "url": "https://updated.url",
      "type": "dialog"
    }'

Returns

An empty 204 No Content response will be returned.

Delete a Webhook

Endpoint

DELETE /apps/<apikey>/webhooks/<webhook_id>
Update selected webhook

Example Request

curl -X DELETE \
    https://management.filestackapi.com/apps/<apikey>/webhooks/<webhook_id> \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

An empty 204 No Content response will be returned.

Get Analytics Overview

Endpoint

GET /apps/<apikey>/analytics/overview

Get analytics for selected application (for selected time period)

Parameters

Parameter Type Default
from_date RFC 3339 timestamp Start of billing period for given application
to_date RFC 3339 timestamp End of billing period for given application

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/analytics/overview?from_date=2017-01-01T10:19:10&to_date=2017-02-01T10:19:10 \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with list of applications in JSON structure:
{
    "from_date": "2016-11-11T10:19:10",
    "to_date": "2016-11-29T10:19:10",
    "stats": {
      "transfer": 123456789,
      "creations": 12,
      "transformations": 20,
      "dialog_open": 7,
      "reads": 398
    }    
}

Get Daily Analytics

Endpoint

GET /apps/<apikey>/analytics/overview/daily
Get analytics for selected application aggregated by days (for selected time period)

Parameters

Parameter Type Default
from_date RFC 3339 timestamp Start of billing period for given application
to_date RFC 3339 timestamp End of billing period for given application

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/analytics/overview/daily?from_date=2017-01-01T10:19:10&to_date=2017-02-01T10:19:10 \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with list of applications in JSON structure:
{
    "from_date": "2016-11-11T10:19:10",
    "to_date": "2016-12-29T10:19:10",
    "daily_stats": [
      {
         "date": "2016-12-02",
         "stats": {
           "transfer": 304120,
           "transformations": 2,
           "dialog_open": 1,
           "creations": 1,
           "reads": 1
         }
      },
      {
         "date": "2016-12-21",
         "stats": {
           "transfer": 12113468,
           "transformations": 2,
           "dialog_open": 32,
           "creations": 32,
           "reads": 21
         }
      }
    ]    
}

Get Analytics by File Type

Endpoint

GET /apps/<apikey>/analytics/filetypes
Get the number of uploaded files aggregated by file type (for selected time period)

Parameters

Parameter Type Default
from_date RFC 3339 timestamp Start of billing period for given application
to_date RFC 3339 timestamp End of billing period for given application

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/analytics/filetypes?from_date=2017-01-01T10:19:10&to_date=2017-02-01T10:19:10 \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with list of applications in JSON structure:
{
    "from_date": "2016-11-11T10:19:10",
    "to_date": "2016-12-29T10:19:10",
    "stats": {
      "text": 12,
      "image": 321,
      "video": 0,
      "audio": 70,
      "pdf": 1,
      "other": 66
    }    
}

Get Analytics by Service

Endpoint

GET /apps/<apikey>/analytics/service

Parameters

Parameter Type Default
from_date RFC 3339 timestamp Start of billing period for given application
to_date RFC 3339 timestamp End of billing period for given application

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/analytics/services?from_date=2017-01-01T10:19:10&to_date=2017-02-01T10:19:10 \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with list of applications in JSON structure:
{
    "from_date": "2016-11-11T10:19:10",
    "to_date": "2016-12-29T10:19:10",
    "stats": {
      "customsource": 0,
      "dropbox-storage": 0,
      "video": 0,
      "ftp": 0,
      "github": 0,
      "rackspace-storage": 0,
      "dropbox": 0,
      "filestack": 3,
      "box": 0,
      "twitter": 0,
      "instagram": 0,
      "amazon-storage": 0,
      "gmail": 0,
      "googledrive": 0,
      "url": 0,
      "evernote": 0,
      "webdav": 0,
      "clouddrive": 0,
      "flickr": 0,
      "facebook": 0,
      "picasa": 0,
      "imagesearch": 0,
      "onedrive": 0,
      "gcs-storage": 0,
      "azure-storage": 0,
      "imgur": 0
    }    
}

Add Custom Auth Keys

Endpoint

POST /apps/<apikey>/credentials/auth/<service>

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/credentials/auth/<service> \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "key": "<service_key>",
      "secret": "<service_secret>"
    }'

Request Parameters

Parameter Type Description
key String Client key
secret String Client secret (optional for some services, e.g. imagesearch)
Available services:
  • alfresco
  • box
  • dropbox
  • evernote
  • facebook
  • flickr
  • googledrive
  • imagesearch
  • github
  • gmail
  • instagram
  • picasa
  • skydrive

Returns

An 204 No Content response will be returned.

Add a Custom S3 Source

Endpoint

POST /apps/<apikey>/credentials/customsource/S3

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/credentials/customsource/S3 \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "s3_source_name": "<source_name>",
      "s3_access_id": "<S3_ACCESS_ID>",
      "s3_secret_key": "<S3_SECRET_KEY>",
      "s3_bucket": "<S3_BUCKET>",
      "s3_path": "<path_in_your_bucket>",
    }'

Request Parameters

Parameter Type Description
s3_source_name STRING Name that will be displayed in dialog
s3_access_id STRING AWS Access Key ID with access to your bucket.
s3_secret_key STRING AWS Secret Access Key.
s3_bucket STRING Name of your bucket
s3_path STRING Specific path in your bucket (optional, root folder by default)

Returns

An 204 No Content response will be returned.

Enable or Disable a Custom S3 Source

Endpoint

POST /apps/<apikey>/credentials/customsource/S3/state

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/credentials/customsource/S3/state \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "enabled": true
    }'

Request Parameters

Parameter Type Description
enabled BOOL Should custom S3 source be enabled

Returns

An 204 No Content response will be returned.

Test a Custom S3 Source

Endpoint

POST /apps/<apikey>/credentials/customsource/S3/test

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/credentials/customsource/S3/test \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

200 Ok response will be returned. If Custom Source credentials are correct, {"success": true} will be returned as response body. If credentials are wrong, success will be false and an error message will be included: {"success": false, "error": "Bucket Not Found"} (response status code will still be 200).

Get Whitelisted Domains

Endpoint

GET /apps/<apikey>/whitelisted_domains

Example Request

curl -X GET \
    https://management.filestackapi.com/apps/<apikey>/whitelisted_domains \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with JSON structure:
{
    "upload": {
      "domains": [
        "test.com"
      ],
      "block_no_origin": true
    },
    "delivery": {
      "domains": [
        "test.com"
      ],
      "block_no_origin": true
    },    
}

Whitelisted Domains Block No Origin

Endpoint

POST /apps/<apikey>/whitelisted_domains/block_no_origin

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/whitelisted_domains/block_no_origin \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "delivery": true,
      "upload": true
    }'

Request Parameters

Parameter Type Description
delivery BOOL whitelist type (optional)
upload BOOL whitelist type (optional)

Returns

200 Ok response will be returned. If parameters are correct, {"success": true}

Add Whitelisted Domains

Endpoint

POST /apps/<apikey>/whitelisted_domains/<whitelist_type>/add

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/whitelisted_domains/<whitelist_type>/add \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "domains": [
        "test.com",
        "test-dev.com"
      ]
    }'

Request Parameters

Parameter Type Description
domains LIST Domain list

Returns

A 200 OK response will be returned with JSON structure:
{
    "success": true,
    "added": "2"
}
This request adds new domains to the whitelist. If a domain already exists on the list, it is ignored.

Remove Whitelisted Domains

Endpoint

POST /apps/<apikey>/whitelisted_domains/<whitelist_type>/remove

Example Request

curl -X POST \
    https://management.filestackapi.com/apps/<apikey>/whitelisted_domains/<whitelist_type>/remove \
    -H "API-Version: 1.0.0" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer <token>"\
    -d '{
      "domains": [
        "test.com",
        "test-dev.com"
      ]
    }'

Request Parameters

Parameter Type Description
domains LIST Domain list

Returns

A 200 OK response will be returned with JSON structure:
{
    "success": true,
    "removed": "2"
}
This request removes specified domains from the whitelist. If a domain in your request is not on the list, it is ignored.

Drop All Whitelisted Domains

Endpoint

DELETE /apps/<apikey>/whitelisted_domains/<whitelist_type>

Example Request

curl -X DELETE \
    https://management.filestackapi.com/apps/<apikey>/whitelisted_domains/<whitelist_type> \
    -H "API-Version: 1.0.0" \
    -H "Authorization: Bearer <token>"

Returns

A 200 OK response will be returned with JSON structure {"success": true}

Notes

This action only removes the domains from the whitelist. The block_no_origin setting for this whitelist type is preserved.

Overview
Authentication
Error Handling
Versioning
Date Format
API Reference
Obtain a Token
Endpoint
Example Request
Returns
Notes
Create an Application
Endpoint
Example Request
Parameters
Returns
List Applications
Endpoint
Example Request
Query Parameters
Returns
Get an Application
Endpoint
Example Request
Returns
Update an Application
Endpoint
Example Request
Parameters
Returns
Delete an Application
Endpoint
Example Request
Returns
Get Security Settings
Endpoint
Example Request
Returns
Modify Security Settings
Endpoint
Example Request
Request Parameters
Returns
Add S3 Storage
Endpoint
Example Request
Parameters
Returns
Notes
Add Google Cloud Storage Credentials
Endpoint
Example Request
Parameters
Returns
Notes
Add Azure Storage Credentials
Endpoint
Example Request
Parameters
Returns
Notes
Add Rackspace Storage Credentials
Endpoint
Example Request
Parameters
Returns
Notes
Test Storage Credentials
Endpoint
Example Request
Returns
Notes
List Webhooks
Endpoint
Example Request
Returns
Add a Webhook
Endpoint
Example Request
Request Parameters
Returns
Update a Webhook
Endpoint
Example Request
Returns
Delete a Webhook
Endpoint
Example Request
Returns
Get Analytics Overview
Endpoint
Parameters
Example Request
Returns
Get Daily Analytics
Endpoint
Parameters
Example Request
Returns
Get Analytics by File Type
Endpoint
Parameters
Example Request
Returns
Get Analytics by Service
Endpoint
Parameters
Example Request
Returns
Add Custom Auth Keys
Endpoint
Example Request
Request Parameters
Returns
Add a Custom S3 Source
Endpoint
Example Request
Request Parameters
Returns
Enable or Disable a Custom S3 Source
Endpoint
Example Request
Request Parameters
Returns
Test a Custom S3 Source
Endpoint
Example Request
Returns
Get Whitelisted Domains
Endpoint
Example Request
Returns
Whitelisted Domains Block No Origin
Endpoint
Example Request
Request Parameters
Returns
Add Whitelisted Domains
Endpoint
Example Request
Request Parameters
Returns
Remove Whitelisted Domains
Endpoint
Example Request
Request Parameters
Returns
Drop All Whitelisted Domains
Endpoint
Example Request
Returns
Notes