Kaleido API Reference (1.0)

Download OpenAPI specification:Download

Administrative interface for resource lifecycle operations, account management, and devops. All calls require a valid API Key provisioned against the callee's Kaleido Organization.

Application Credentials

A username/password pair securing external access to a node via basic access authentication. Credentials are bound to a consortia membership, are only applicable within the environment in which they are created and must be provisioned against the same membership ID of the targeted node in order for an authenticated connection to take place. The credential password is a onetime-viewable string and is not stored by the Kaleido backend.

Get the Application Credentials of a particular environment

path Parameters
consortia_id
required
string
environment_id
required
string

Responses

200

Application Credentials Retrieved

500

Internal Error

get /consortia/{consortia_id}/environments/{environment_id}/appcreds
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create new Application Credentials

path Parameters
consortia_id
required
string
environment_id
required
string
Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

environment_id
string

Auto-generated key for the environment that owns this key

membership_id
required
string

Auto-generated key for the membership that owns this key

dapp_id
string

The DApp that owns this Key

name
string

User defined name for App Key

auth_type
string
Value:"basic_auth"

The type of authentication associated with this key

hash
string

Internal storage used to validate an key (we do not store the whole key)

Responses

200

Application Credential Updated

201

Application Credential Created

404

Application Credential Not Found

500

Internal Error

post /consortia/{consortia_id}/environments/{environment_id}/appcreds
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Get a specific Application Credential

path Parameters
consortia_id
required
string
environment_id
required
string
appkey_id
required
string

Responses

200

Application Credential Retrieved

404

Application Credential Not Found

500

Internal Error

get /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Upsert a specific Application Credential

path Parameters
consortia_id
required
string
environment_id
required
string
appkey_id
required
string
Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

environment_id
string

Auto-generated key for the environment that owns this key

membership_id
required
string

Auto-generated key for the membership that owns this key

dapp_id
string

The DApp that owns this Key

name
string

User defined name for App Key

auth_type
string
Value:"basic_auth"

The type of authentication associated with this key

hash
string

Internal storage used to validate an key (we do not store the whole key)

Responses

200

Application Credential Updated

201

Application Credential Created

404

Application Credential Not Found

500

Internal Error

put /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Update a specific Application Credential

path Parameters
consortia_id
required
string
environment_id
required
string
appkey_id
required
string
Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

environment_id
string

Auto-generated key for the environment that owns this key

membership_id
required
string

Auto-generated key for the membership that owns this key

dapp_id
string

The DApp that owns this Key

name
string

User defined name for App Key

auth_type
string
Value:"basic_auth"

The type of authentication associated with this key

hash
string

Internal storage used to validate an key (we do not store the whole key)

Responses

200

Application Credential Updated

201

Application Credential Created

404

Application Credential Not Found

500

Internal Error

patch /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "environment_id": "string",
  • "membership_id": "string",
  • "dapp_id": "string",
  • "name": "string",
  • "auth_type": "basic_auth",
  • "hash": "string"
}

Delete an Application Credential

path Parameters
consortia_id
required
string
environment_id
required
string
appkey_id
required
string

Responses

204

Application Credential Deleted

404

Application Credential Not Found

500

Internal Error

delete /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "errorMessage": "string"
}

API Keys

Organization-specific administrative tokens that allow for resource CRUD operations via the Kaleido API. Similar to application credentials, API Keys are onetime-viewable strings and are not stored by the Kaleido backend. These endpoints do not support API Key generation and can only be used to retrieve or edit existing keys.

Get info about the API Keys

Responses

200

API Keys Retrieved

500

Internal Error

get /apikeys
US API base endpoint
https://console.kaleido.io/api/v1/apikeys
EU API base endpoint
https://console-eu.kaleido.io/api/v1/apikeys
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/apikeys
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/apikeys

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create a new API Key

Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

user_id
string
name
string

User defined name for API Key

salt
string
hash
string
org_id
required
string

Responses

200

API Key Updated

201

API Key Created

404

API Key Not Found

500

Internal Error

post /apikeys
US API base endpoint
https://console.kaleido.io/api/v1/apikeys
EU API base endpoint
https://console-eu.kaleido.io/api/v1/apikeys
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/apikeys
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/apikeys

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "user_id": "string",
  • "name": "string",
  • "salt": "string",
  • "hash": "string",
  • "org_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "user_id": "string",
  • "name": "string",
  • "salt": "string",
  • "hash": "string",
  • "org_id": "string"
}

Get a specific API Key

path Parameters
apikey_id
required
string

Responses

200

API Key Retrieved

404

API Key Not Found

500

Internal Error

get /apikeys/{apikey_id}
US API base endpoint
https://console.kaleido.io/api/v1/apikeys/{apikey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/apikeys/{apikey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/apikeys/{apikey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/apikeys/{apikey_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "user_id": "string",
  • "name": "string",
  • "salt": "string",
  • "hash": "string",
  • "org_id": "string"
}

Update an API Key

path Parameters
apikey_id
required
string
Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

user_id
string
name
string

User defined name for API Key

salt
string
hash
string
org_id
required
string

Responses

200

API Key Updated

201

API Key Created

404

API Key Not Found

500

Internal Error

patch /apikeys/{apikey_id}
US API base endpoint
https://console.kaleido.io/api/v1/apikeys/{apikey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/apikeys/{apikey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/apikeys/{apikey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/apikeys/{apikey_id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "user_id": "string",
  • "name": "string",
  • "salt": "string",
  • "hash": "string",
  • "org_id": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "user_id": "string",
  • "name": "string",
  • "salt": "string",
  • "hash": "string",
  • "org_id": "string"
}

Delete an API Key

path Parameters
apikey_id
required
string

Responses

204

API Key Deleted

404

API Key Not Found

500

Internal Error

delete /apikeys/{apikey_id}
US API base endpoint
https://console.kaleido.io/api/v1/apikeys/{apikey_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/apikeys/{apikey_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/apikeys/{apikey_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/apikeys/{apikey_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "errorMessage": "string"
}

Audit

Retrieves a history of resource-specific CRUD operations associated with a Kaleido user's organization and/or a specific consortia (e.g. invitation issued, membership created, node deleted, etc.)

Get all events with the provided jwt

Responses

200

Audit Retrieved

500

Internal Error

get /audit
US API base endpoint
https://console.kaleido.io/api/v1/audit
EU API base endpoint
https://console-eu.kaleido.io/api/v1/audit
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/audit
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/audit

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get all events for a particular consortia

path Parameters
consortia_id
required
string

Responses

200

Audit Retrieved

500

Internal Error

get /audit/{consortia_id}
US API base endpoint
https://console.kaleido.io/api/v1/audit/{consortia_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/audit/{consortia_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/audit/{consortia_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/audit/{consortia_id}

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Consortia

A top level Kaleido resource defined by a charter and grouping of memberships. The memberships in a consortia can be bound to a single Kaleido Org or distributed across multiple Kaleido Orgs. A consortia encapsulates environments and the subsequent resources (e.g. nodes and application credentials) provisioned within an environment.

Get all consortia

Responses

200

Consortia Retrieved

500

Internal Error

get /consortia
US API base endpoint
https://console.kaleido.io/api/v1/consortia
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create a consortia

Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

root
string
name
string

User-friendly consortia name

description
string

User-friendly description of the consortia use case

owner
string

Auto-populated field containing the Organization ID which created the Consortia

state
string
Enum:"setup" "live" "delete_pending" "deleted"

Lifecycle state of the consortia

mode
string
Enum:"single-org" "multi-org"

Administrative type of the consortia

deleted_at
string

Auto-populated field denoting when an environment was successfully deleted

member_policy
string

DEPRECATED. Base policy determining rules around updating consortia membership

amend_policy
string

DEPRECATED. Base policy determining rules around updating consortia policies

locked_policies
Array of string

DEPRECATED. Policies that, when inherited by a deployed environment, cannot be updated

Responses

200

Consortia Updated

201

Consortia Created

404

Consortia Not Found

500

Internal Error

post /consortia
US API base endpoint
https://console.kaleido.io/api/v1/consortia
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "root": "string",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "state": "setup",
  • "mode": "single-org",
  • "deleted_at": "string",
  • "member_policy": "string",
  • "amend_policy": "string",
  • "locked_policies":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "root": "string",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "state": "setup",
  • "mode": "single-org",
  • "deleted_at": "string",
  • "member_policy": "string",
  • "amend_policy": "string",
  • "locked_policies":
    [
    ]
}

Get a specific consortia

path Parameters
consortia_id
required
string

Responses

200

Consortia Retrieved

404

Consortia Not Found

500

Internal Error

get /consortia/{consortia_id}
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "root": "string",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "state": "setup",
  • "mode": "single-org",
  • "deleted_at": "string",
  • "member_policy": "string",
  • "amend_policy": "string",
  • "locked_policies":
    [
    ]
}

Upsert a specific consortia

path Parameters
consortia_id
required
string
Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

root
string
name
string

User-friendly consortia name

description
string

User-friendly description of the consortia use case

owner
string

Auto-populated field containing the Organization ID which created the Consortia

state
string
Enum:"setup" "live" "delete_pending" "deleted"

Lifecycle state of the consortia

mode
string
Enum:"single-org" "multi-org"

Administrative type of the consortia

deleted_at
string

Auto-populated field denoting when an environment was successfully deleted

member_policy
string

DEPRECATED. Base policy determining rules around updating consortia membership

amend_policy
string

DEPRECATED. Base policy determining rules around updating consortia policies

locked_policies
Array of string

DEPRECATED. Policies that, when inherited by a deployed environment, cannot be updated

Responses

200

Consortia Updated

201

Consortia Created

404

Consortia Not Found

500

Internal Error

put /consortia/{consortia_id}
US API base endpoint
https://console.kaleido.io/api/v1/consortia/{consortia_id}
EU API base endpoint
https://console-eu.kaleido.io/api/v1/consortia/{consortia_id}
Sydney API base endpoint
https://console-ap.kaleido.io/api/v1/consortia/{consortia_id}
Seoul API base endpoint
https://console-ko.kaleido.io/api/v1/consortia/{consortia_id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "root": "string",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "state": "setup",
  • "mode": "single-org",
  • "deleted_at": "string",
  • "member_policy": "string",
  • "amend_policy": "string",
  • "locked_policies":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "_id": "string",
  • "_revision": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "root": "string",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "state": "setup",
  • "mode": "single-org",
  • "deleted_at": "string",
  • "member_policy": "string",
  • "amend_policy": "string",
  • "locked_policies":
    [
    ]
}

Update a specific consortia

path Parameters
consortia_id
required
string
Request Body schema: application/json
_id
string^[0-9a-z]{10}$
_revision
string
created_at
string

Auto-populated field denoting when a record is created

updated_at
string

Auto-populated field denoting when a record is updated

root
string
name