Skip to main content
This page documents all outbound network requests the Superblocks data plane makes to Superblocks Cloud. Use this as a reference when configuring firewall rules or network allowlists.

​
Required Requests

The following table lists all the required operational outgoing calls from the agent to Superblocks Cloud. The Superblocks Cloud host is https://api.superblocks.com, and most calls to Superblocks Cloud are authenticated with the organization-specific agent key, which is loaded into the agent as the SUPERBLOCKS_AGENT_KEY environment variable. Note: This list shows requests made to Superblocks Cloud APIs that are required for proper agent operation. Network requests made by Superblocks users as part of API steps, for example, requests made to an API using the requests library in Python steps or requests made by integrations that access public REST APIs, are also outbound calls made by the agent. These outbound calls are made at the discretion of agent operators.
PathTypeSourceTargetDescriptionAuthentication
/api/v1/agents/registerPOSTAgentSuperblocks CloudRoute called to register an agent with Superblocks Cloud.Superblocks Agent Key
/api/v1/agentsDELETEAgentSuperblocks CloudRoute called to deregister an agent from the Superblocks Cloud (called during agent shutdown).Superblocks Agent Key
/api/v1/agents/healthcheckPOSTAgentSuperblocks CloudRoute called to post health check information to Superblocks Cloud, including diagnostic and execution metrics (default: called on a 30s interval).Superblocks Agent Key
/api/v1/agents/datasource/:id (DEPRECATED)POSTAgentSuperblocks CloudRoute called to get OAuth client information needed to perform OAuth Token exchanges.Superblocks Agent Key + User JWT
/api/v1/integrationsGETAgentSuperblocks CloudRoute called to fetch integration configurations from the Superblocks Cloud.Superblocks Agent Key + User JWT
/api/v1/agents/user/userTokenGETAgentSuperblocks CloudRoute called to get the currently logged in user’s OAuth2.0 access token from Superblocks Cloud. This is then sent as an authorization header or query parameter in integration requests.Superblocks Agent Key + User JWT
/api/v1/agents/user/userTokenPOSTAgentSuperblocks CloudRoute called after OAuth token exchanges are completed to cache access tokens generated for the use in Superblocks Cloud. Token caches ensure users do not have to login multiple times for an Integration.Superblocks Agent Key + User JWT
/api/v1/agents/user/userTokenDELETEAgentSuperblocks CloudRoute called to delete all of the user’s OAuth2.0 access tokens that have been cached for Integrations. Initiated when developers use the logoutIntegration() function in frontend JS.Superblocks Agent Key + User JWT
/api/v1/agents/userTokenGETAgentSuperblocks CloudRoute called to get a shared OAuth2.0 access token to use in Integration authentication.Superblocks Agent Key + User JWT + Org API Token
/api/v1/agents/userTokenPOSTAgentSuperblocks CloudRoute called after a successful OAuth2.0 token exchange to save shared access token for an Integration.Superblocks Agent Key + User JWT + Org API Token
/api/v1/oauth2/gsheets/refreshPOSTAgentSuperblocks CloudRoute called to refresh Google Sheet OAuth2.0 access tokens used by the Google Sheets integration.Superblocks Agent Key + User JWT + Org API Token
/api/v2/agents/auditPOSTAgentSuperblocks CloudRoute called to create audit log records in Superblocks Cloud for API executions.Superblocks Agent Key
/api/v2/agents/pending-jobsPOSTAgentSuperblocks CloudRoute called to fetch deployed Scheduled Jobs that should be run by the agent based on their configured schedule.Superblocks Agent Key
/api/v3/apis/:apiIdGETAgentSuperblocks CloudRoute called to fetch an API definition from Superblocks Cloud. For deployed APIs, definitions are fetched from the Global Edge Network by default, and round trip to the Superblocks Cloud only if unavailable.Superblocks Agent Key + User JWT + Org API Token
/api/v3/apis/signaturesPUTAgentSuperblocks CloudWhen Agent Signing is enabled, this route is called to update the signature of an API when signatures are updated as a result of a re-signing job.Superblocks Agent Key
/api/v2/applications/signaturesPUTAgentSuperblocks CloudWhen Agent Signing is enabled, this route is called to update the signature on an Application when signatures are updated as a result of a re-signing job.Superblocks Agent Key
/api/v2/keyrotations/claim-resourcesPOSTAgentSuperblocks CloudWhen Agent Signing is enabled, this route is called when a re-signing job is in progress to fetch a batch of resources (APIs and Applications) for the agent to re-sign.Superblocks Agent Key

​
Optional Requests

The following table lists the optional outgoing calls from the agent to Superblocks Cloud, that are used primarily for observability. The Superblocks Cloud host is specific to each call, and all of these calls are authenticated with the organization-specific agent key, which is loaded into the agent as the SUPERBLOCKS_AGENT_KEY environment variable.
HostTypeSourceTargetDescriptionAuthentication
events.intake.superblocks.comPOSTAgentSuperblocks CloudRoute called to upload execution analytics events.Superblocks Agent Key
metadata.intake.superblocks.comPOSTAgentSuperblocks CloudRoute called to upload integration configuration metadata to the Superblocks Cloud.Superblocks Agent Key
logs.intake.superblocks.comPOSTAgentSuperblocks CloudRoute called to upload batched agent platform logs for the Observability feature.Superblocks Agent Key