API Reference for App2App (Destination Management) (1.0)

Download OpenAPI specification:Download

The Kaleido messaging service offers a Kafka-backed bilateral app-to-app pipeline for the encryption, submission and decryption of messages between members of an environment. Apps can securely subscribe to pertinent topics for consumption and delivery of data, without reliance on ancillary messaging constructs and subsequent integration of offline data. The service leverages the On-Chain Registry to establish and verify membership identities. Messages are automatically encrypted and signed, thereby ensuring that only the intended recipient can access the content while also providing proof of the sender’s identity.

IMPORTANT
The REST API in this document describes how to manage App2App destinations. These operations can also be done through the Kaleido console. For more information visit https://docs.kaleido.io/kaleido-services/app2app/destinations/

To send and receive messages create an app credential and use it to connect to the socket.io API:
https://docs.kaleido.io/kaleido-services/app2app/send-receive/

Code snippets for sending and receiving messages can be found here:
https://github.com/kaleido-io/app2app-snippets

Address Book

Retrieves all App2App destinations in the environm

Retrieves all App2App destinations in the environment grouped by membership.

Responses

200

App2App destinations in the environment grouped by membership.

400

Invalid request

500

Internal error

get/addressbook
https://console.kaleido.io/api/v1/app2app/{runtime_id}/addressbook

Response samples

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

Destinations

Retrieves the App2App runtime destinations.

Retrieves the App2App runtime destinations.

Responses

200

App2App runtime destinations.

400

Invalid request

500

Internal error

get/destinations
https://console.kaleido.io/api/v1/app2app/{runtime_id}/destinations

Response samples

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

Creates a destination.

Creates a destination.

path Parameters
destination_name
required
string

Destination name. Allowed characters [a-z] [0-9] [- , _ , .] maximum length 44

Request Body schema: application/json
kaleido_managed
boolean

True: Kaleido will generate and manage the destination key. False: customer will generate key externally and upload public certificate to ID-Registry.

Responses

200

App2App runtime destinations.

400

Invalid request

500

Internal error

put/destinations/{destination_name}
https://console.kaleido.io/api/v1/app2app/{runtime_id}/destinations/{destination_name}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kaleido_managed": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "result": "string",
  • "action": "string"
}

Deletes a destination.

Deletes a destination.

path Parameters
destination_name
required
string

Destination name. Allowed characters [a-z] [0-9] [- , _ , .] maximum length 44

Responses

204

Destination deleted.

400

Invalid request

500

Internal error

delete/destinations/{destination_name}
https://console.kaleido.io/api/v1/app2app/{runtime_id}/destinations/{destination_name}

Response samples

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

Certificates

Retrieves the destination public certificate PEM.

Retrieves the destination public certificate PEM.

path Parameters
destination_name
required
string

Destination name.

Responses

200

Destination public certificate PEM

400

Invalid request

500

Internal error

get/destinations/{destination_name}/certificate
https://console.kaleido.io/api/v1/app2app/{runtime_id}/destinations/{destination_name}/certificate

Response samples

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

Retrieves the destination public certificate PEM i

Retrieves the destination public certificate PEM in JSON format.

path Parameters
destination_name
required
string

Destination name.

Responses

200

Destination public certificate PEM in JSON format.

400

Invalid request

500

Internal error

get/destinations/{destination_name}/certificatejson
https://console.kaleido.io/api/v1/app2app/{runtime_id}/destinations/{destination_name}/certificatejson

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "certificate": "string"
}