GET suppliers/{supplier}

Gets information about a specified supplier.

Only suppliers that were created with REST API, FalsePositive, and InternalTI suppliers are returned.

Path

/api/1.0/suppliers/{supplier}

Method

GET

Request headers

This request has the following headers.

Request headers

Name

Value

Description

Authorization

string (base 64)

Authentication string.

Accept

application/json

Response content type.

Request parameters

This request has the following parameters:

Request parameters

Name

Parameter type

Description

supplier

Path

Name of the supplier.

Request body

This request has an empty body.

Request example

The following is an example of a GET suppliers/{supplier} request.

GET https://192.0.2.57/api/1.0/suppliers/ExampleSupplier

 

Accept: application/json

Authorization: Basic dXNlcjpwYXNzd29yZA==

Response headers

The response has the following headers.

Response headers

Name

Value

Description

Content-Type

application/json

Response content type.

Content-Length

integer

Response body size, in bytes.

Response body

The response body contains a JSON array with a supplier information object.

[

{

"name": "%SUPPLIER_NAME%",

"status": "%SUPPLIER_STATUS%",

"confidence": %SUPPLIER_CONFIDENCE%,

"retention": %SUPPLIER_RETENTION%,

"vendor": "%SUPPLIER_VENDOR%"

}

]

Supplier information object properties are described in the following table.

Supplier information object properties

Property

Value

Description

name

string

Name of the supplier.

status

string

Status of the supplier.

This value is enabled if the supplier is enabled.

This value is disabled if the supplier is disabled.

confidence

integer

Confidence level for indicators from this supplier.

retention

integer

Retention period for indicators, in minutes.

vendor

string

Supplier vendor name.

Response example

The following is an example of a GET suppliers/{supplier} request response.

НТТР/1.1 200 ОК

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 108

[

{name:"ExampleSupplier", "status":"enabled", "confidence": 90, "retention": 5000, "vendor": "ExampleVendor"}

]

Error responses

For more information about possible response statuses, see section "Response statuses".

An error response contains a JSON object with the error description.

[

{

"status": "Supplier doesn't exist",

}

]

Error object properties are described in the following table.

Error object properties

Property

Value

Description

status

string

Error description.

Error response example

The following is an example of a GET suppliers error response.

НТТР/1.1 404 Supplier doesn't exist

Date:Mon, 23 Dec 2019 09:56:10 UTC

Content-Type: application/json

Content-Length: 34

[{"status": "Supplier doesn't exist"}]

Page top