uploadToConnector

Upload a file through a connector for future processing. Returns a requestId that can be used to track the upload status.

Examples

GraphQL

mutation UploadToConnector($connectorId: String!, $mode: ConnectorUploadMode!, $file: Upload!) {
  uploadToConnector(connectorId: $connectorId, mode: $mode, file: $file) {
    requestId
    success
    message
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "connectorId": "2",
  "mode": "keep",
  "file": "example"
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation UploadToConnector($connectorId: String!, $mode: ConnectorUploadMode!, $file: Upload!) { uploadToConnector(connectorId: $connectorId, mode: $mode, file: $file) { requestId success message } }",
 "variables": {
    "connectorId": "2",
    "mode": "keep",
    "file": "example"
  }
}'

Node.js

const query = 'mutation UploadToConnector($connectorId: String!, $mode: ConnectorUploadMode!, $file: Upload!) { uploadToConnector(connectorId: $connectorId, mode: $mode, file: $file) { requestId success message } }';

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: {
      connectorId: "2",
      mode: "keep",
      file: "example"
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation UploadToConnector($connectorId: String!, $mode: ConnectorUploadMode!, $file: Upload!) { uploadToConnector(connectorId: $connectorId, mode: $mode, file: $file) { requestId success message } }'

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": {
      "connectorId": "2",
      "mode": "keep",
      "file": "example"
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your uploadToConnector mutation.

Argument	Description	Supported fields
connectorId String! required	Id of the connector to upload the file through
mode ConnectorUploadMode! required	Whether to keep or cleanup connector upload artifacts after processing
file Upload! required

Fields

Return type: UploadFileResponse!

You can use the following field(s) to specify what information your uploadToConnector mutation will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
requestId String!	Unique identifier for tracking the upload request
success Boolean!	Indicates whether the file upload was successful
message String	Human-readable error message when success is false (e.g. duplicate or oversized upload)