Content Management API > Uploads filter

Create a new filter

Body parameters

id string Optional

RFC 4122 UUID of upload filter expressed in URL-safe base64 format

Example:

"-Lo34LFSTLmgPToamzJLcg"

type string Required

Must be exactly "upload_filter".

attributes.name string Required

The name of the filter

Example:

"Draft posts"

attributes.filter object Required

The actual filter

Example:

{ status: { eq: "draft" } }

attributes.shared boolean Required

Whether it's a shared filter or not

Returns

Returns a resource object of type upload_filter.

Examples

1
POST https://site-api.datocms.com/upload-filters HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "upload_filter",
10
    "attributes": {
11
      "name": "Draft posts",
12
      "filter": {
13
        "status": {
14
          "eq": "draft"
15
        }
16
      },
17
      "shared": true
18
    }
19
  }
20
}

1
curl -g 'https://site-api.datocms.com/upload-filters' \
2
  -X POST \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"upload_filter","attributes":{"name":"Draft posts","filter":{"status":{"eq":"draft"}},"shared":true}}}'

1
await fetch("https://site-api.datocms.com/upload-filters", {
2
  method: "POST",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({
10
    data: {
11
      type: "upload_filter",
12
      attributes: {
13
        name: "Draft posts",
14
        filter: { status: { eq: "draft" } },
15
        shared: true,
16
      },
17
    },
18
  }),
19
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "upload_filter",
10
    "id": "-Lo34LFSTLmgPToamzJLcg",
11
    "attributes": {
12
      "name": "Draft posts",
13
      "filter": {
14
        "status": {
15
          "eq": "draft"
16
        }
17
      },
18
      "shared": true
19
    }
20
  }
21
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.