Connectors API
Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.
Endpoints 22
projects.locations.connections
- GETReports readiness status of the connector
/v2/:name:checkReadinessReports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand. - GETReports the status of the connection
/v2/:name:checkStatus?executionConfig.headers=stringReports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a… - POSTExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated…
/v2/:name:exchangeAuthCodeExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials). - POSTExecutes a generic HTTP request
/v2/:name:executeHttpRequestExecutes a generic HTTP request. This supports all payload formats including REST/JSON, GraphQL, XML, SOAP, and Multipart by passing the rendered payload as… - POSTExecutes a SQL statement specified in the body of the request
/v2/:connection:executeSqlQueryExecutes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from… - POSTGenerate toolspec override for the given list of toolNames.
/v2/:name:generateConnectionToolspecOverrideGenerate toolspec override for the given list of toolNames. - GETLists custom tool names.
/v2/:name:listCustomToolNamesLists custom tool names. - POSTRefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new…
/v2/:name:refreshAccessTokenRefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials). - POSTLists all available tools with POST.
/v2/:parent/toolsLists all available tools with POST.
projects.locations.connections.tools
- GETLists all available tools.
/v2/:parent/tools?executionConfig.headers=string&pageSize=0&pageToken=string&toolNames=stringLists all available tools. - POSTExecutes a specific tool.
/v2/:name:executeExecutes a specific tool.
projects.locations.connections.resources
- GETGets a specific resource.
/v2/:name?executionConfig.headers=stringGets a specific resource. - POSTGets a specific resource with POST.
/v2/:nameGets a specific resource with POST. - GETLists all available resources.
/v2/:parent/resources?executionConfig.headers=string&pageSize=0&pageToken=stringLists all available resources.
projects.locations.connections.entityTypes.entities
- DELETEDeletes an existing entity row matching the entity type and entity id specified in the request.
/v2/:name?executionConfig.headers=stringDeletes an existing entity row matching the entity type and entity id specified in the request. - PATCHUpdates an existing entity row matching the entity type and entity id specified in the request
/v2/:name?executionConfig.headers=stringUpdates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are… - GETLists entity rows of a particular entity type contained in the request
/v2/:parent/entities?conditions=string&executionConfig.headers=string&pageSize=0&pageToken=string&sortBy=string&sortOrder=stringLists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by'… - POSTCreates a new entity row of the specified entity type in the external system
/v2/:parent/entities?executionConfig.headers=stringCreates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request.… - POSTDeletes entities based on conditions specified in the request and not on entity id.
/v2/:entityType/entities:deleteEntitiesWithConditions?conditions=string&executionConfig.headers=stringDeletes entities based on conditions specified in the request and not on entity id. - POSTUpdates entities based on conditions specified in the request and not on entity id.
/v2/:entityType/entities:updateEntitiesWithConditions?conditions=string&executionConfig.headers=stringUpdates entities based on conditions specified in the request and not on entity id.
projects.locations.connections.actions
- GETGets the schema of all the actions supported by the connector.
/v2/:parent/actions?executionConfig.headers=string&pageSize=0&pageToken=string&view=ACTION_VIEW_UNSPECIFIEDGets the schema of all the actions supported by the connector.
projects.locations.connections.entityTypes
- GETLists metadata related to all entity types present in the external system.
/v2/:parent/entityTypes?executionConfig.headers=string&pageSize=0&pageToken=string&view=ENTITY_TYPE_VIEW_UNSPECIFIEDLists metadata related to all entity types present in the external system.
API details
- Base URL
https://connectors.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 22 operations on 17 pathsPOST 11GET 9PATCH 1DELETE 1
- Main resources
- projects.locations.connections 9projects.locations.connections.entityTypes.entities 6projects.locations.connections.resources 3projects.locations.connections.tools 2projects.locations.connections.actions 1projects.locations.connections.entityTypes 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Connectors API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Connectors API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Reports readiness status of the connector” (GET /v2/:name:checkReadiness), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Connectors API?
Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface. It is listed under Developer tools and has 22 endpoints.
Who publishes the Connectors API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Connectors API?
Requests go to https://connectors.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Connectors API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Connectors API have?
22 operations on 17 paths (11 POST, 9 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.connections, projects.locations.connections.entityTypes.entities, projects.locations.connections.resources, projects.locations.connections.tools.
Is forking the Connectors API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.