Attachments

Crop image attachment

Create a cropped version of an existing image attachment. The crop object is appended to the crops array property of the attachment document. The newly uploaded image file will be stored with a filename using the crop properties: {_id}-{name}.{top}.{left}.{width}.{height}.{extension}

Access: an API key with any one of content:images:write, content:files:write or content:videos:write (or a master above one). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.

Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After.

POST

@apostrophecms

attachment

crop

cURL

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/attachment/crop \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_id": "ckj0akbxa003vp39kfbxgb8zg",
  "crop": {
    "top": 10,
    "left": 15,
    "width": 300,
    "height": 200
  }
}
'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const result = await site.attachments().cropAttachment({ id: 'ckj0akbxa003vp39kfbxgb8zg', crop: { top: 10, left: 15, width: 300, height: 200 } });

true

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization

string

header

required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Query Parameters

aposMode

enum<string>

default:published

published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403.

Available options:

draft,

published

aposLocale

string

The locale to read or write, e.g. en (default: the site’s default locale).

Example:

"fr"

Body

application/json

_id

string

required

The _id property of an existing image attachment document

Example:

"ckj0akbxa003vp39kfbxgb8zg"

crop

object

required

Crop coordinates and dimensions

Show child attributes

Response

Image cropped successfully

Returns true on successful crop

Example:

true

cURL

curl --request POST \
  --url https://{host}/api/v1/@apostrophecms/attachment/crop \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_id": "ckj0akbxa003vp39kfbxgb8zg",
  "crop": {
    "top": 10,
    "left": 15,
    "width": 300,
    "height": 200
  }
}
'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const result = await site.attachments().cropAttachment({ id: 'ckj0akbxa003vp39kfbxgb8zg', crop: { top: 10, left: 15, width: 300, height: 200 } });

true

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Crop image attachment

Authorizations

Query Parameters

Body

Response