NOnotefile
description

POST /v1/description/{descriptionName}

Changed on

Create or replace a global description record, Blues staff only (up to 10MB). The request Content-Type is stored and returned on GET; when omitted it is detected (JSON or text).

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/description/{descriptionName}
  • Auth
    HTTP bearer

Request body application/octet-stream

string binary required

Response

Description record created or updated.

content_typestring required

The stored content type, either "application/json" or "text/plain; charset=utf-8".

created_atinteger required

When the record was first created (Unix seconds).

created_bystring

The actor who created the record.

lengthinteger required

The content length in bytes.

md5string required

The hex-encoded MD5 of the content.

modified_atinteger required

When the record was last updated (Unix seconds).

modified_bystring

The actor who last updated the record.

namestring required

The record name (letters, digits, '.', '_' or '-').

owner_uidstring

The owning project (app) UID for project-scoped records; empty for global.

scopestring required

The ownership scope of the record ("global" or "project").

Changes