Files

Core Instance Files

Files from a core instance with backward pagination.

get

/v1/core_instances/{coreInstanceID}/files

Authorizations

userproject

Path parameters

coreInstanceIDstring · uuidrequired

Query parameters

lastinteger

Limit to the last files.

beforestring

Paginate files before the given cursor.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/core_instances/{coreInstanceID}/files' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "coreInstanceID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "myfile",
      "contents": "text",
      "encrypted": false,
      "createdAt": "2025-03-12T04:21:59.128Z",
      "updatedAt": "2025-03-12T04:21:59.128Z"
    }
  ],
  "endCursor": "text",
  "count": 1
}

OK

Create Core Instance File

Create a new file within a core instance. The file will be created with the given name and content. If encypted is set to true, the file will be encrypted using the core instance's encryption key. The name must be unique among all files within the core instance.

post

/v1/core_instances/{coreInstanceID}/files

Authorizations

userproject

Path parameters

coreInstanceIDstring · uuidrequired

Body

namestringrequired

Example: myfile

contentsstring · byterequired

The contents of the file to be created in base 64 format.

encryptedboolean · default: falserequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/core_instances/{coreInstanceID}/files' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "myfile",
    "contents": "text",
    "encrypted": false
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-03-12T04:21:59.128Z"
}

Created