Import an archive as a new tenant

POST

/v2/tenants/{tenantId}/import

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/v2/tenants/example/import"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/gzip")
    .method("POST", HttpRequest.BodyPublishers.ofString("binary"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'http://localhost:8080/v2/tenants/example/import';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/gzip'},
  body: 'binary'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8080/v2/tenants/example/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/gzip' \
  --data binary

Available inBundledCluster Embedded answers 501

AuthAuthenticated Bearer token or console session with X-CSRF-Token · requires tenant:admin

Creates the tenant tenantId from an archive (the request body, as the export wrote it): the archive’s own tenant id, or another one (the id mapping). The tenant id must hold nothing: a new id, or one whose tenant was purged. The archive must be whole and unchanged, and written by an engine of the same version (400 otherwise).

Everything is stored in one transaction, or nothing is. The tenant starts suspended: activate it when you are ready, and its running instances go on where they stopped (timers that came due meanwhile fire at once). Keys stay as they were; repeating a request the tenant answered before the export gets that answer. API clients come without a secret: give each a new one. Needs tenant administration on every tenant, as creating a tenant does.

Authorizations

Parameters

Path Parameters

tenantId

required

string

>= 1 characters <= 256 characters

Header Parameters

x-tenant-id

string

>= 1 characters

Tenant selection. A principal bound to one tenant may omit it; if sent, it must equal that tenant (403 otherwise). A principal that may act in several tenants must send it on every request: without it the request is refused with 400, and a tenant it may not act in is refused with 403.

Request Body^required

application/gzip

string format: binary

Responses

201

The tenant is imported, suspended.

application/json

object

tenantId

required

string

name

required

string

state

required

string

Allowed values: SUSPENDED

partition

required

The partition that hosts the tenant.

integer

tenantSeq

required

The tenant’s last change in the archive.

integer

source

required

Where the archive was taken.

object

tenantId

string

exportedAt

string format: date-time

cell

integer

partition

integer

engineVersion

string

positionOffset

What was added to each record position of the archive.

integer

rows

required

Rows imported per section.

object

key

additional properties

integer

Example

{
  "state": "SUSPENDED"
}

400

The request is malformed, or it uses a property or filter this release does not support.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:invalid-argument",
  "title": "Bad Request",
  "status": 400,
  "detail": "entity key must be a positive int64 string",
  "instance": "/v2/process-instances/0"
}

401

No valid credential was presented.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer credential is required",
  "instance": "/v2/tenants/2251799813685262/import"
}

Headers

WWW-Authenticate

string

Allowed value: Bearer

403

The caller lacks the required permission, a tenant named in the request is not the caller’s tenant, or a cookie write has no valid CSRF token.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The principal lacks the action this route requires",
  "instance": "/v2/tenants/2251799813685262/import"
}

409

An idempotency-key conflict, or a command the target’s current state does not allow.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key is already associated with another request",
  "instance": "/v2/tenants/2251799813685262/import"
}

500

An internal failure. The details are never exposed.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:internal",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed",
  "instance": "/v2/tenants/2251799813685262/import"
}

501

The operation is not offered in the engine’s current deployment mode.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:mode-not-supported",
  "title": "Mode Not Supported",
  "status": 501,
  "detail": "/v2/clock is not supported in bundled mode: the deterministic virtual clock and the storage-free reset exist only for the Embedded engine; Bundled and Cluster run on the system clock over durable history, which cannot be pinned, rewound or discarded",
  "instance": "/v2/clock",
  "mode": "bundled"
}

503

Backpressure, or a dependency is not ready. Retry with the same idempotency key.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/v2/tenants/2251799813685262/import"
}

Import an archive as a new tenant

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

400

Example

401

Example

Headers

403

Example

409

Example

500

Example

501

Example

503

Example

Request Body^required