> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--connectors/queries/get-connector-resources.md). # getConnectorResources Retrieves available resources for a connector, such as repositories, projects, or other assets that can be monitored. ### Examples {% tabs %} {% tab title="GraphQL" %} ```graphql query GetConnectorResources($getConnectorResourcesInput: GetConnectorResourcesInput!) { getConnectorResources(getConnectorResourcesInput: $getConnectorResourcesInput) { resources { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } monitorAllNewlyCreatedResources total selected } } ``` #### Variables This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. ```json { "getConnectorResourcesInput": { "connectorID": "2", "credentialsId": "example", "featureFlags": "example" } } ``` {% endtab %} {% tab title="cURL" %} ```shell curl -X POST \ https://api.cloud.ox.security/api/apollo-gateway \ -H 'Content-Type: application/json' \ -H 'Authorization: YOUR_API_TOKEN' \ -d '{ "query": "query GetConnectorResources($getConnectorResourcesInput: GetConnectorResourcesInput!) { getConnectorResources(getConnectorResourcesInput: $getConnectorResourcesInput) { resources { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } monitorAllNewlyCreatedResources total selected } }", "variables": { "getConnectorResourcesInput": { "connectorID": "2", "credentialsId": "example", "featureFlags": "example" } } }' ``` {% endtab %} {% tab title="Node.js" %} ```javascript const query = 'query GetConnectorResources($getConnectorResourcesInput: GetConnectorResourcesInput!) { getConnectorResources(getConnectorResourcesInput: $getConnectorResourcesInput) { resources { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } monitorAllNewlyCreatedResources total selected } }'; fetch("https://api.cloud.ox.security/api/apollo-gateway", { method: "POST", headers: { "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, body: JSON.stringify({ query: query, // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. variables: { getConnectorResourcesInput: { connectorID: "2", credentialsId: "example", featureFlags: "example" } } }) }) .then(response => response.json()) .then(result => console.log(JSON.stringify(result, null, 2))) .catch(error => console.error('Error:', error)); ``` {% endtab %} {% tab title="Python" %} ```python import requests query = 'query GetConnectorResources($getConnectorResourcesInput: GetConnectorResourcesInput!) { getConnectorResources(getConnectorResourcesInput: $getConnectorResourcesInput) { resources { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType children { id name resourceOrgName isMonitored resourceType iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } iconName settingsAvailable credentialsId } monitorAllNewlyCreatedResources total selected } }' response = requests.post( "https://api.cloud.ox.security/api/apollo-gateway", headers={ "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, json={ "query": query, # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. "variables": { "getConnectorResourcesInput": { "connectorID": "2", "credentialsId": "example", "featureFlags": "example" } } } ) if response.status_code == 200: result = response.json() print(result) else: print(f"Error: {response.status_code}") print(response.text) ``` {% endtab %} {% endtabs %} ### Arguments You can use the following argument(s) to customize your `getConnectorResources` query. | Argument | Description | Supported fields | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | getConnectorResourcesInput [`GetConnectorResourcesInput!`](/api-documentation/api-reference/api--connectors/types/inputs/get-connector-resources-input.md) required | Input parameters specifying which connector and credentials to fetch resources for |

connectorID String!
credentialsId String
featureFlags JSON

| ### Fields Return type: [`ConnectorResourceResponse`](/api-documentation/api-reference/api--connectors/types/objects/connector-resource-response.md) You can use the following field(s) to specify what information your `getConnectorResources` query will return. Please note that some fields may have their own subfields. | Field | Description | Supported fields | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | resources [`[Resource]`](/api-documentation/api-reference/api--connectors/types/objects/resource.md) | List of resources that are available and their monitoring status |

id String
name String
resourceOrgName String
isMonitored Boolean
resourceType ResourceType
children \[Resource]
iconName ResourceIcon
settingsAvailable Boolean
credentialsId String

| | monitorAllNewlyCreatedResources `Boolean` | Indicates if newly created resources should be automatically monitored | | | total `Int` | Total number of available resources | | | selected `Int` | Number of selected (monitored) resources | | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ox.security/api-documentation/api-reference/api--connectors/queries/get-connector-resources.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.