Source API Methods and Examples
The Collector Management API allows you to manage Collectors and Sources from an HTTP endpoint. This topic describes the Source API methods, which you can use to create installed or hosted Sources of any type by specifying the sourceType
parameter. When using local configuration file management you can no longer manage Sources through the Collector Management API.
You cannot use the Source API to create Microsoft Office 365 sources, Google Audit sources, or any other sources that require OAuth-based authentication with another vendor.
Collector Management APIs are not yet built with OpenAPI specifications and therefore not included in our Swagger docs. Instead, refer to the below documentation.
Rate limiting
- A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.
- A rate limit of 10 concurrent requests to any API endpoint applies to an access key.
If a rate is exceeded, a rate limit exceeded 429 status code is returned.
Response fields
See Use JSON to Configure Sources for a description of Source parameters.
GET methods
List Sources
GET/collectors/{collectorId}/sources
Get Source by ID
GET/collectors/[collectorId]/sources/{sourceId}
POST methods
Create a Source
POST/collectors/{collectorId}/sources
PUT methods
Update a Source
PUT/collectors/{collectorId}/sources/{sourceId}
DELETE methods
Delete a Source
DELETE/collectors/{collectorId}/sources/{sourceId}
Error Codes and Messages
Code | Message |
---|---|
BadRequestBladeId | Request body contains an invalid Source ID. |
CannotModifySources | Collector is in JSON mode, user cannot create, delete, or update sources using the API. |
CollectorDescriptionTooLong | Maximum description length is 1024 characters. |
CollectorNameTooLong | Maximum name length is 128 characters. |
createValidationError | The specified ID is invalid. |
DuplicateResourceName | A resource with the same name already exists. |
EmptySourceType | Need to specify a source type. |
InvalidSourceType | Invalid Source type for the requested operation. |