Encode and sign object

POST 
/v2/tools/encode-and-sign

Encodes and signs any JSON object. The encoded value includes a signature tied to the authenticated user's ID, which can later be verified using the decode-and-verify endpoint.

Important: The request must specify the Content-Type: application/json HTTP header.

Request

Bodyrequired

• object object

Status 200

{
  "data": {
    "encoded": "eyJwYXlsb2FkIjoiLi4uIiwic2lnbmF0dXJlIjoiLi4uIn0="
  }
}

Schema

• data object required

  • encoded string required
    Example: eyJwYXlsb2FkIjoiLi4uIiwic2lnbmF0dXJlIjoiLi4uIn0=

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.

Status 401

Unauthorized - authentication required or invalid token.

{
  "error": {
    "type": "token-not-valid",
    "message": "Authentication token is not valid."
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.

Status 403

Forbidden - insufficient permissions to perform this action.

{
  "error": {
    "type": "permission-denied",
    "message": "You do not have permission to perform this action."
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.

Status 405

Method not allowed.

{
  "error": {
    "type": "method-not-allowed",
    "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.

Status 413

Payload too large - the request body exceeds the size limit.

{
  "error": {
    "type": "request-too-large",
    "message": "The POST payload is too large (limit: 9437184 bytes, actual length: 10485760 bytes)."
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.

Status 415

Unsupported media type - the Content-Encoding of the request is not supported.

{
  "error": {
    "type": "unsupported-content-encoding",
    "message": "Content-Encoding \"bla\" is not supported."
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.

Status 429

Too many requests - rate limit exceeded.

{
  "error": {
    "type": "rate-limit-exceeded",
    "message": "You have exceeded the rate limit. Please try again later."
  }
}

Schema

• error object required

  • type ErrorType (string)

    Machine-processable error type identifier.

    Possible values: [actor-memory-limit-exceeded, actor-not-found, invalid-input, method-not-allowed, permission-denied, rate-limit-exceeded, record-not-found, record-not-unique, record-or-token-not-found, request-id-invalid, request-too-large, run-failed, run-timeout-exceeded, token-not-valid, unknown-build-tag, unsupported-content-encoding]

  • message string

    Human-readable error message describing what went wrong.