NAV
terminal

Introduction

Welcome to the Confidential Cloud API!

You can use our API to access all public Confidential Cloud API endpoints.

Authentication

curl "https://api.confidentialcloud.io/v1" \
  -H "Authorization: <YOU_API_KEY>"

Confidential Cloud uses API keys to allow access to the API. You can register a new API key at our developer portal.

Confidential Cloud expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: <YOU_API_KEY>

Application

Deploy application to enclave corresponding to enclaveID

curl "https://api.confidentialcloud.io/v1/application/"

Obtain info about the application posted to enclave corresponding to enclaveID.

HTTPS Request

GET https://api.confidentialcloud.io/v1/application/

Add application

curl "https://api.confidentialcloud.io/v1/application/2" \
-X POST

Add an application to the enclave corresponding to enclaveID

HTTPS Request

POST https://api.confidentialcloud.io/v1/application/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Attestation

Show attestation info

curl "https://api.confidentialcloud.io/v1/attestations/2"

This endpoint shows enclave attestation results by its enclaveID.

HTTPS Request

GET https://api.confidentialcloud.io/v1/attestations/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Re-attest

curl "https://api.confidentialcloud.io/v1/attestations/2/run"

Re-run attestation of the enclave corresponding to enclaveID, return attestation result.

HTTPS Request

GET https://api.confidentialcloud.io/v1/attestations/<enclaveID/run>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Data

Obtain data information

curl "https://api.confidentialcloud.io/v1/data/2"

Get info about volume of data posted to the enclave corresponding to enclaveID

HTTPS Request

GET https://api.confidentialcloud.io/v1/data/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Deploy data to enclave

curl "https://api.confidentialcloud.io/v1/data/2" \
-X POST

Send data to enclave identified by enclaveID.

HTTPS Request

POST https://api.confidentialcloud.io/v1/data/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Enclaves

List all enclaves

curl "https://api.confidentialcloud.io/v1/enclaves/"

This endpoint lists all enclaves.

HTTPS Request

GET https://api.confidentialcloud.io/v1/enclaves/

Create a new enclave

curl "https://api.confidentialcloud.io/v1/enclaves/" \
-X POST

This endpoint creates a new enclave.

HTTPS Request

POST https://api.confidentialcloud.io/v1/enclaves/

List a specific enclave

curl "https://api.confidentialcloud.io/v1/enclave/2"

This endpoint lists an enclave by its enclaveID.

HTTPS Request

GET https://api.confidentialcloud.io/v1/enclave/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Delete a specific Enclave

curl "https://api.confidentialcloud.io/v1/enclave/2" \
  -X DELETE

This endpoint deletes a specific Enclave.

HTTPS Request

DELETE https://api.confidentialcloud.io/v1/enclave/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to delete

Shows enclave stats by enclaveID

curl "https://api.confidentialcloud.io/v1/enclave/2/stats"

This endpoint show enclave stats by its enclaveID.

HTTPS Request

GET https://api.confidentialcloud.io/v1/enclave/<enclaveID/stats>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Results

Retrieve results

curl "https://api.confidentialcloud.io/v1/results/2"

Retrieve final results by enclaveID.

HTTPS Request

GET https://api.confidentialcloud.io/v1/results/<enclaveID>

URL Parameters

Parameter Description
enclaveID The ID of the enclave to retrieve

Secrets

List all shared information tokens

curl "https://api.confidentialcloud.io/v1/secrets/"

Shows all enclaveID and publicKey shared to and from user with a third party.

HTTPS Request

GET https://api.confidentialcloud.io/v1/secrets/

Show per-enclave shared information tokens

curl "https://api.confidentialcloud.io/v1/secrets/2/3"

Shows all enclaveID and publicKey shared to and from user with a third party.

HTTPS Request

GET https://api.confidentialcloud.io/v1/secrets/<userID>/<enclaveID>

URL Parameters

Parameter Description
userID The ID of the user
enclaveID The ID of the enclave to retrieve

Share infromation tokens with user identified by

curl "https://api.confidentialcloud.io/v1/secrets/2/3" \
-X POST

This POST request shares enclaveID and publicKey with the user identified by userID.

HTTPS Request

POST https://api.confidentialcloud.io/v1/enclaves/<userID>/<enclaveID>