Kaleido integration: operations for AI agents
Kaleido connects to Type.com as an integration. This page lists the 177 operations documented for Claude and Codex in Type.com: 91 read, 66 write, 20 destructive.
About Kaleido
Kaleido is a full-stack platform for building and managing enterprise blockchain networks and applications.
Categories: Developer Tools & IT
How to connect Kaleido to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- This integration is not available through Type’s MCP server. It remains available in Type.
To add the connection, follow the steps in Space connections.
Documented operations
177 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
177 operations listed.
API Keys
- Read
Get info about the API Keys
GET /apikeys
GET /apikeys - Read
Get a specific API Key
GET /apikeys/{apikey_id}
GET /apikeys/{apikey_id} - Write
Create a new API Key
POST /apikeys
POST /apikeys - Write
Update an API Key
PATCH /apikeys/{apikey_id}
PATCH /apikeys/{apikey_id} - Destructive
Delete an API Key
DELETE /apikeys/{apikey_id}
DELETE /apikeys/{apikey_id}
Application Credentials
- Read
Get the Application Credentials of a particular environment
GET /consortia/{consortia_id}/environments/{environment_id}/appcreds
GET /consortia/{consortia_id}/environments/{environment_id}/appcreds - Read
Get a specific Application Credential
GET /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
GET /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id} - Write
Create new Application Credentials
POST /consortia/{consortia_id}/environments/{environment_id}/appcreds
POST /consortia/{consortia_id}/environments/{environment_id}/appcreds - Write
Upsert a specific Application Credential
PUT /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
PUT /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id} - Write
Update a specific Application Credential
PATCH /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id} - Write
Regenerate the password for a specific app cred
POST /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}/regenerate
POST /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}/regenerate - Destructive
Delete an Application Credential
DELETE /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/appcreds/{appkey_id}
Audit
- Read
Get all events with the provided jwt
GET /audit
GET /audit - Read
Get all events for a particular consortia
GET /audit/{consortia_id}
GET /audit/{consortia_id}
Configurations
- Read
Get the configurations for an environment
GET /consortia/{consortia_id}/environments/{environment_id}/configurations
GET /consortia/{consortia_id}/environments/{environment_id}/configurations - Read
Get a specific configuration
GET /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id}
GET /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id} - Write
Create a configurations for the environment
POST /consortia/{consortia_id}/environments/{environment_id}/configurations
POST /consortia/{consortia_id}/environments/{environment_id}/configurations - Write
Upsert a specific configuration
PUT /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id}
PUT /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id} - Write
Update a specific configuration
PATCH /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id} - Destructive
Delete a specific configuration
DELETE /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/configurations/{config_id}
Consortia
- Read
Get all consortia
GET /consortia
GET /consortia - Read
Get a specific consortia
GET /consortia/{consortia_id}
GET /consortia/{consortia_id} - Read
Get the charter of a specific consortia
GET /consortia/{consortia_id}/charter
GET /consortia/{consortia_id}/charter - Write
Create a consortia
POST /consortia
POST /consortia - Write
Update a specific consortia
PATCH /consortia/{consortia_id}
PATCH /consortia/{consortia_id} - Destructive
Delete a specific consortia
DELETE /consortia/{consortia_id}
DELETE /consortia/{consortia_id}
Contracts
- Read
Get all contracts for the consortia
GET /consortia/{consortia_id}/contracts
GET /consortia/{consortia_id}/contracts - Read
Get a specific contract
GET /consortia/{consortia_id}/contracts/{contract_id}
GET /consortia/{consortia_id}/contracts/{contract_id} - Write
Create a contract for the consortia
POST /consortia/{consortia_id}/contracts
POST /consortia/{consortia_id}/contracts - Write
Update a specific contract
PATCH /consortia/{consortia_id}/contracts/{contract_id}
PATCH /consortia/{consortia_id}/contracts/{contract_id} - Destructive
Delete a specific contract
DELETE /consortia/{consortia_id}/contracts/{contract_id}
DELETE /consortia/{consortia_id}/contracts/{contract_id}
Compiled Contracts
- Read
Get all compiled contracts for the consortia
GET /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts
GET /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts - Read
Get a specific compiled contract
GET /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id}
GET /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id} - Write
Create a compiled contract for the consortia
POST /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts
POST /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts - Write
Create a compiled contract for the consortia by uploading a large file
POST /binaries/consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts
POST /binaries/consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts - Write
Update a specific compiled contract
PATCH /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id}
PATCH /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id} - Write
Promote the compiled contract to an environment. This will install a Gateway API on the environment which can be used t…
Promote the compiled contract to an environment. This will install a Gateway API on the environment which can be used to deploy new instances of this contract, as well as interact with previously deployed instances.
POST /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id}/promote - Destructive
Delete a specific compiled contract
DELETE /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id}
DELETE /consortia/{consortia_id}/contracts/{contract_id}/compiled_contracts/{compiled_contract_id}
Integrations
- Read
Get all integrations for the environment
GET /consortia/{consortia_id}/environments/{environment_id}/integrations
GET /consortia/{consortia_id}/environments/{environment_id}/integrations - Read
Get a specific integration
GET /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id}
GET /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id} - Write
Create an integration for the environment
POST /consortia/{consortia_id}/environments/{environment_id}/integrations
POST /consortia/{consortia_id}/environments/{environment_id}/integrations - Write
Update a specific integration
PATCH /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id} - Write
Reset the state of the integration by clearing out the tracking details and regenerating the app cred
POST /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id}/reset
POST /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id}/reset - Destructive
Delete a specific integration
DELETE /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/integrations/{integration_id}
Channels
- Read
Get all channels in the environment (Fabric environments only)
GET /consortia/{consortia_id}/environments/{environment_id}/channels
GET /consortia/{consortia_id}/environments/{environment_id}/channels - Read
Get a specific channel
GET /consortia/{consortia_id}/environments/{environment_id}/channels/{channel_id}
GET /consortia/{consortia_id}/environments/{environment_id}/channels/{channel_id} - Write
Create a channel in the Fabric environment
POST /consortia/{consortia_id}/environments/{environment_id}/channels
POST /consortia/{consortia_id}/environments/{environment_id}/channels - Write
Update a specific channel's members list
PATCH /consortia/{consortia_id}/environments/{environment_id}/channels/{channel_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/channels/{channel_id} - Write
Deploy chaincode to a channel
POST /consortia/{consortia_id}/environments/{environment_id}/channels/{channel_id}/deploy
POST /consortia/{consortia_id}/environments/{environment_id}/channels/{channel_id}/deploy
Invitations
- Read
Get all invitations for the current user where they are the target
GET /invitations
GET /invitations - Read
Get all invitations for the consortia
GET /consortia/{consortia_id}/invitations
GET /consortia/{consortia_id}/invitations - Read
Get a specific invitation
GET /consortia/{consortia_id}/invitations/{invitation_id}
GET /consortia/{consortia_id}/invitations/{invitation_id} - Read
Get a specific invitation with some extra info
GET /consortia/{consortia_id}/invitations/{invitation_id}/charter
GET /consortia/{consortia_id}/invitations/{invitation_id}/charter - Write
Create an invitation for the consortia
POST /consortia/{consortia_id}/invitations
POST /consortia/{consortia_id}/invitations - Write
Upsert a specific invitation
PUT /consortia/{consortia_id}/invitations/{invitation_id}
PUT /consortia/{consortia_id}/invitations/{invitation_id} - Write
Update a specific invitation
PATCH /consortia/{consortia_id}/invitations/{invitation_id}
PATCH /consortia/{consortia_id}/invitations/{invitation_id} - Destructive
Delete a specific invitation
DELETE /consortia/{consortia_id}/invitations/{invitation_id}
DELETE /consortia/{consortia_id}/invitations/{invitation_id}
Zones
- Read
Get all deployment zones for the consortia
GET /consortia/{consortia_id}/zones
GET /consortia/{consortia_id}/zones - Read
Get a specific consortia deployment zone
GET /consortia/{consortia_id}/zones/{zone_id}
GET /consortia/{consortia_id}/zones/{zone_id} - Read
Get all deployment zones for the environment
GET /consortia/{consortia_id}/environments/{environment_id}/zones
GET /consortia/{consortia_id}/environments/{environment_id}/zones - Read
Get a specific environment deployment zone
GET /consortia/{consortia_id}/environments/{environment_id}/zones/{zone_id}
GET /consortia/{consortia_id}/environments/{environment_id}/zones/{zone_id} - Write
Create a deployment zone for the consortia
POST /consortia/{consortia_id}/zones
POST /consortia/{consortia_id}/zones - Write
Update a specific consortia deployment zone
PATCH /consortia/{consortia_id}/zones/{zone_id}
PATCH /consortia/{consortia_id}/zones/{zone_id} - Write
Create a deployment zone for the environment
POST /consortia/{consortia_id}/environments/{environment_id}/zones
POST /consortia/{consortia_id}/environments/{environment_id}/zones - Write
Update a specific environment deployment zone
PATCH /consortia/{consortia_id}/environments/{environment_id}/zones/{zone_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/zones/{zone_id} - Destructive
Delete a specific consortia deployment zone
DELETE /consortia/{consortia_id}/zones/{zone_id}
DELETE /consortia/{consortia_id}/zones/{zone_id} - Destructive
Delete a specific environment deployment zone
DELETE /consortia/{consortia_id}/environments/{environment_id}/zones/{zone_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/zones/{zone_id}
Environments
- Read
Get all environments for the consortia
GET /consortia/{consortia_id}/environments
GET /consortia/{consortia_id}/environments - Read
Get a specific environment
GET /consortia/{consortia_id}/environments/{environment_id}
GET /consortia/{consortia_id}/environments/{environment_id} - Read
Get an Environment's status
GET /consortia/{consortia_id}/environments/{environment_id}/status
GET /consortia/{consortia_id}/environments/{environment_id}/status - Read
Get an Environment's Ethereum-specific stats
Only applicable to Ethereum environments. Returns each node's transaction pool status, block height and p2p network peers
GET /consortia/{consortia_id}/environments/{environment_id}/ethstats - Read
Get an Environment's genesis configuration
GET /consortia/{consortia_id}/environments/{environment_id}/genesis
GET /consortia/{consortia_id}/environments/{environment_id}/genesis - Read
Get ether balance of the account.
GET /consortia/{consortia_id}/environments/{environment_id}/eth/getbalance/{address}
GET /consortia/{consortia_id}/environments/{environment_id}/eth/getbalance/{address} - Read
Get an Environment's Backup Status
Only applicable to Ethereum environments that have Environment Backups enabled. Returns a record of history of all backup files for an environment.
GET /consortia/{consortia_id}/environments/{environment_id}/backup/status - Read
Get an Environment's Backup Configuration
GET /consortia/{consortia_id}/environments/{environment_id}/backup
GET /consortia/{consortia_id}/environments/{environment_id}/backup - Write
Create an environment for the consortia
POST /consortia/{consortia_id}/environments
POST /consortia/{consortia_id}/environments - Write
Update a specific environment
PATCH /consortia/{consortia_id}/environments/{environment_id}
PATCH /consortia/{consortia_id}/environments/{environment_id} - Write
Upgrade a specific environment to the latest version
POST /consortia/{consortia_id}/environments/{environment_id}/upgrade
POST /consortia/{consortia_id}/environments/{environment_id}/upgrade - Write
Apply available hard fork EIPs to a specific environment
POST /consortia/{consortia_id}/environments/{environment_id}/hardfork
POST /consortia/{consortia_id}/environments/{environment_id}/hardfork - Write
Fund an account from the environment's faucet. Can transfer ETH or tokens owned by the faucet account.
POST /consortia/{consortia_id}/environments/{environment_id}/eth/fundaccount
POST /consortia/{consortia_id}/environments/{environment_id}/eth/fundaccount - Write
Create an Environment's Backup Configuration
POST /consortia/{consortia_id}/environments/{environment_id}/backup
POST /consortia/{consortia_id}/environments/{environment_id}/backup - Write
Update an Environment's Backup Configuration
PATCH /consortia/{consortia_id}/environments/{environment_id}/backup
PATCH /consortia/{consortia_id}/environments/{environment_id}/backup - Destructive
Delete a specific environment
DELETE /consortia/{consortia_id}/environments/{environment_id}
DELETE /consortia/{consortia_id}/environments/{environment_id} - Destructive
Delete a specific environment's backup configuration
DELETE /consortia/{consortia_id}/environments/{environment_id}/backup
DELETE /consortia/{consortia_id}/environments/{environment_id}/backup
Identity Proof
- Read
Get all proofs of an organization
GET /orgs/{org_id}/idproofs
GET /orgs/{org_id}/idproofs - Read
Get a specific ID proof of an organization
GET /orgs/{org_id}/idproofs/{proof_id}
GET /orgs/{org_id}/idproofs/{proof_id} - Write
Add an ID proof to an organization
POST /orgs/{org_id}/idproofs
POST /orgs/{org_id}/idproofs - Write
Update the details of an ID proof of an organization
PATCH /orgs/{org_id}/idproofs/{proof_id}
PATCH /orgs/{org_id}/idproofs/{proof_id} - Destructive
Remove an ID proof from an organization
DELETE /orgs/{org_id}/idproofs/{proof_id}
DELETE /orgs/{org_id}/idproofs/{proof_id}
Ledger
- Read
Get a range of blocks in the chain
GET /ledger/{consortia_id}/{environment_id}/blocks
GET /ledger/{consortia_id}/{environment_id}/blocks - Read
Get a specific block in the chain
GET /ledger/{consortia_id}/{environment_id}/blocks/{block_number}
GET /ledger/{consortia_id}/{environment_id}/blocks/{block_number} - Read
Get the transactions in a specific block
GET /ledger/{consortia_id}/{environment_id}/blocks/{block_number}/transactions
GET /ledger/{consortia_id}/{environment_id}/blocks/{block_number}/transactions - Read
Get the last 25 transactions from the ledger or lookup using the range parameters
GET /ledger/{consortia_id}/{environment_id}/transactions
GET /ledger/{consortia_id}/{environment_id}/transactions - Read
Get information about a transaction
GET /ledger/{consortia_id}/{environment_id}/transactions/{hash}
GET /ledger/{consortia_id}/{environment_id}/transactions/{hash} - Read
Get the receipt of a specific transaction
GET /ledger/{consortia_id}/{environment_id}/transactions/{hash}/receipt
GET /ledger/{consortia_id}/{environment_id}/transactions/{hash}/receipt - Read
Get a deployed contract's information
GET /ledger/{consortia_id}/{environment_id}/addresses/{address}
GET /ledger/{consortia_id}/{environment_id}/addresses/{address} - Read
Get a deployed contract's transactions
GET /ledger/{consortia_id}/{environment_id}/addresses/{address}/transactions
GET /ledger/{consortia_id}/{environment_id}/addresses/{address}/transactions - Read
Get the contracts deployed on the chain
GET /ledger/{consortia_id}/{environment_id}/contracts
GET /ledger/{consortia_id}/{environment_id}/contracts - Read
Get info about a specific deployed contract
GET /ledger/{consortia_id}/{environment_id}/contracts/{address}
GET /ledger/{consortia_id}/{environment_id}/contracts/{address} - Read
Get the Gateway API's that have been promoted to this environment
GET /ledger/{consortia_id}/{environment_id}/gateway_apis
GET /ledger/{consortia_id}/{environment_id}/gateway_apis - Read
Get info about a specific Gateway API
GET /ledger/{consortia_id}/{environment_id}/gateway_apis/{gateway_api_id}
GET /ledger/{consortia_id}/{environment_id}/gateway_apis/{gateway_api_id} - Read
Get all the deployed contract instances of a single Gateway API
GET /ledger/{consortia_id}/{environment_id}/gateway_apis/{gateway_api_id}/contracts
GET /ledger/{consortia_id}/{environment_id}/gateway_apis/{gateway_api_id}/contracts - Read
Get the token contracts deployed on the chain
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts - Read
Get info about a specific deployed token contract
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address} - Read
Get the balance of a particular account for a specific erc20 token contract
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}/balanceOf/{account}
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}/balanceOf/{account} - Read
Get the owner of a particular tokenId for a specific erc721 token contract
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}/ownerOf/{tokenId}
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}/ownerOf/{tokenId} - Read
Get transfers of a token
Get transfer transactions for a specific token contract, with pagination and a limit of up to 25 records per query"
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}/transfers - Read
Get transfers of a token to/from a wallet address
Get transfer transactions to or from a particular wallet address for a specific token contract, with pagination and a limit of up to 25 records per query"
GET /ledger/{consortia_id}/{environment_id}/tokens/contracts/{address}/transfers/{wallet_address} - Read
Get the ledger stats since a specific time
GET /ledger/{consortia_id}/{environment_id}/stats/{since}
GET /ledger/{consortia_id}/{environment_id}/stats/{since} - Read
Gets last chain activity
GET /ledger/{consortia_id}/{environment_id}/activity
GET /ledger/{consortia_id}/{environment_id}/activity - Write
Update a specific contract's metadata
PUT /ledger/{consortia_id}/{environment_id}/contracts/{address}
PUT /ledger/{consortia_id}/{environment_id}/contracts/{address}
Memberships
- Read
Get all memberships for the current user
GET /memberships
GET /memberships - Read
Get all memberships for the consortia
GET /consortia/{consortia_id}/memberships
GET /consortia/{consortia_id}/memberships - Read
Get a specific membership
GET /consortia/{consortia_id}/memberships/{membership_id}
GET /consortia/{consortia_id}/memberships/{membership_id} - Read
Get a specific membership's owner
GET /consortia/{consortia_id}/memberships/{membership_id}/owner
GET /consortia/{consortia_id}/memberships/{membership_id}/owner - Read
Get a specific membership's identity proof
GET /consortia/{consortia_id}/memberships/{membership_id}/idproof
GET /consortia/{consortia_id}/memberships/{membership_id}/idproof - Write
Create a membership for the consortia
POST /consortia/{consortia_id}/memberships
POST /consortia/{consortia_id}/memberships - Write
Update a specific membership
PATCH /consortia/{consortia_id}/memberships/{membership_id}
PATCH /consortia/{consortia_id}/memberships/{membership_id} - Write
Update the verification of a particular membership
POST /consortia/{consortia_id}/memberships/{membership_id}/verify
POST /consortia/{consortia_id}/memberships/{membership_id}/verify - Destructive
Delete a specific membership
DELETE /consortia/{consortia_id}/memberships/{membership_id}
DELETE /consortia/{consortia_id}/memberships/{membership_id}
Nodes
- Read
Get all nodes for the environment
GET /consortia/{consortia_id}/environments/{environment_id}/nodes
GET /consortia/{consortia_id}/environments/{environment_id}/nodes - Read
Get Node details
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id} - Read
Get Node's runtime status
Provides information about node's runtime, such as current block height, signer list, chain configuration, access URLs and more
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/status - Read
Get a specific node's logs
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/logs/{log_type}
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/logs/{log_type} - Read
Transaction pool summary
Get a summary of the nodes's transaction pool contents
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/txpool/status - Read
Transaction pool contents
Get details of the nodes's transaction pool contents
GET /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/txpool/content - Write
Create a node for the environment
POST /consortia/{consortia_id}/environments/{environment_id}/nodes
POST /consortia/{consortia_id}/environments/{environment_id}/nodes - Write
Update a specific node
PATCH /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id} - Write
Reset a node
Reset a node after modification to backupid/kmsid/zoneid/nodeconfigid to apply any updated configuration. Does not affect chain data on the node
PUT /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/reset - Write
Restart a node
Restart a node's runtime
POST /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/restart - Write
Stop a running node
Stops a running node after voting it out of the signer list - available for POA & IBFT based environments
POST /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/stop - Write
Start a Stopped node
Starts a stopped node, the node is started as a non-signer - available for POA & IBFT based environments
POST /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/start - Write
Create a Node Account
Creates a new account on a node and unlocks it so it's ready to use for signing transactions.
POST /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/eth/accounts - Write
Backup a Node's /qdata
Backup a Node's /qdata content to the attached backup store (AWS S3 bucket or Azure Storage Blob)
PUT /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}/backup - Destructive
Delete a node
DELETE /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/nodes/{node_id}
OAuth Configurations
- Read
Get the OAuth Configurations of a particular environment
GET /consortia/{consortia_id}/environments/{environment_id}/oauth
GET /consortia/{consortia_id}/environments/{environment_id}/oauth - Read
Get a specific OAuth Resource Manager configuration
GET /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id}
GET /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id} - Write
Create new OAuth Configurations
POST /consortia/{consortia_id}/environments/{environment_id}/oauth
POST /consortia/{consortia_id}/environments/{environment_id}/oauth - Write
Upsert a specific OAuth Resource Manager configuration
PUT /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id}
PUT /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id} - Write
Update a specific OAuth Resource Manager configuration
PATCH /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id} - Destructive
Delete an OAuth Resource Manager configuration
DELETE /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/oauth/{oauth_id}
Organizations
- Read
Get the Organizations that user has access to
GET /orgs
GET /orgs - Read
Get a specific Organization
GET /orgs/{org_id}
GET /orgs/{org_id} - Read
Get the plan for a specific Organization
GET /orgs/{org_id}/plan
GET /orgs/{org_id}/plan - Read
Returns type of billing (aws, stripe or other) and details if using stripe
GET /orgs/{org_id}/billing/provider
GET /orgs/{org_id}/billing/provider - Write
Create a new Organization
POST /orgs
POST /orgs - Write
Update a specific Organization
PATCH /orgs/{org_id}
PATCH /orgs/{org_id} - Write
Configures billing provider for the organization
PUT /orgs/{org_id}/billing/provider
PUT /orgs/{org_id}/billing/provider - Destructive
Delete a specific Organization
DELETE /orgs/{org_id}
DELETE /orgs/{org_id}
Plans
- Read
Get a summary of the billing data for the current month.
GET /orgs/{org_id}/billing/summary
GET /orgs/{org_id}/billing/summary - Read
Get all available plans
GET /plans
GET /plans - Read
Determine compliance with all available plans, to find resources that would prevent changing your subscription
GET /plancompliance/{org_id}
GET /plancompliance/{org_id}
Regions
- Read
List of API endpoints and their associated deployment zones
GET /regions
GET /regions
Releases
- Read
Get current list of environment runtime releases
GET /releases
GET /releases - Read
Get a specific environment runtime release
GET /releases/{release_id}
GET /releases/{release_id}
Roles
- Read
Get all roles of an Organization
GET /orgs/{org_id}/roles
GET /orgs/{org_id}/roles - Read
Get a specific role of an Organization
GET /orgs/{org_id}/roles/{role_id}
GET /orgs/{org_id}/roles/{role_id} - Write
Add a role to an Organization
POST /orgs/{org_id}/roles
POST /orgs/{org_id}/roles - Write
Upsert a role of an Organization
PUT /orgs/{org_id}/roles/{role_id}
PUT /orgs/{org_id}/roles/{role_id} - Write
Update the details of a role of an Organization
PATCH /orgs/{org_id}/roles/{role_id}
PATCH /orgs/{org_id}/roles/{role_id} - Destructive
Remove a role from an Organization
DELETE /orgs/{org_id}/roles/{role_id}
DELETE /orgs/{org_id}/roles/{role_id}
Services
- Read
Retrieves all services that the current user owns or has visibility of
GET /services
GET /services - Read
Get all services for the environment
GET /consortia/{consortia_id}/environments/{environment_id}/services
GET /consortia/{consortia_id}/environments/{environment_id}/services - Read
Get a specific service
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id} - Read
Get a specific service's status
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/status
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/status - Read
Get a specific service's logs list
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/logs
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/logs - Read
Get a specific service particular log
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/logs/{log_name}
GET /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/logs/{log_name} - Write
Create a service for the environment
POST /consortia/{consortia_id}/environments/{environment_id}/services
POST /consortia/{consortia_id}/environments/{environment_id}/services - Write
Update a specific service
PATCH /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}
PATCH /consortia/{consortia_id}/environments/{environment_id}/services/{service_id} - Write
Backup a Service's /qdata
Backup a Service's /qdata content to the attached backup store (AWS S3 bucket or Azure Storage Blob)
PUT /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}/backup - Destructive
Delete a specific service
DELETE /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}
DELETE /consortia/{consortia_id}/environments/{environment_id}/services/{service_id}
Tenants
- Read
Get the Tenants of a particular environment
GET /consortia/{consortia_id}/memberships/{membership_id}/tenants
GET /consortia/{consortia_id}/memberships/{membership_id}/tenants - Read
Get a specific Tenant
GET /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id}
GET /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id} - Write
Create new Tenants
POST /consortia/{consortia_id}/memberships/{membership_id}/tenants
POST /consortia/{consortia_id}/memberships/{membership_id}/tenants - Write
Upsert a specific Tenant
PUT /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id}
PUT /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id} - Write
Update a specific Tenant
PATCH /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id}
PATCH /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id} - Destructive
Delete a Tenant
DELETE /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id}
DELETE /consortia/{consortia_id}/memberships/{membership_id}/tenants/{tenant_id}
No operations match.
See How connections work for access and permissions, or browse all integrations.