3. /COMPANIES/{COMPANY ID}

3.1 GET /companies/{company id}

Find a company by ID. Returns indicator data for a single company.

REQUEST - PATH PARAMETERS

Name	Type	Description
*company id	string	ID of company to return. Company IDs can be obtained using the '/companies/ids' endpoint.

RESPONSE

STATUS CODE - 200: Returns a JSON array of objects containing company indicator data for all companies.

Name	Type	Description
companies	array
_id	string	Company ID
_source	object
@timestamp	integrer	Unix creation timestamp in milliseconds, UTC
asn	array
cidr	array
company	string	Company name
created_by	string	Email address of the RedXray user who created the company
domain	array
keywords	array
whois_string	array

STATUS CODE - 401: Missing or invalid API token.

STATUS CODE - 403: Account disabled, or user role prevents access to this resource.

STATUS CODE - 500: Unexpected error.

3.2 PUT /companies/{company id}

Update an existing company.

REQUEST - PATH PARAMETERS

Name	Type	Description
*company id	string	ID of company to update. Company IDs can be obtained using the /companies/ids endpoint.

REQUEST BODY - application/json

Name	Type	Description
asn	array
cidr	array
company	string	Company name
domain	array
keywords	array
whois	array

RESPONSE - RESPONSE MODEL - application/json

STATUS CODE - 200: Company added

Name	Type	Description
success	string	REDXRAY is now working in the background to enrich your company data. The new company will appear in your company list when enrichment is complete. Usually this only takes a few minutes but can take longer with companies with a large number of indicators.

STATUS CODE - 400: Invalid company data.

STATUS CODE - 401: Missing or invalid API token.

STATUS CODE - 403: Account disabled, or user role prevents access to this resource.

STATUS CODE - 500: Unexpected error.

3.3 DELETE /companies/{company id}

Delete a single company.

REQUEST - PATH PARAMETERS

Name	Type	Description
*company id	string	ID of company to update. Company IDs can be obtained using the /companies/ids endpoint.

RESPONSE - RESPONSE MODEL - application/json

STATUS CODE - 200: Company deleted

Name	Type	Description
success	string	Company deleted

STATUS CODE - 401: Missing or invalid API token.

STATUS CODE - 403: Account disabled, or user role prevents access to this resource.

STATUS CODE - 404: Company not found for the supplied company id

STATUS CODE - 500: Unexpected error