Supplier Risk

Add suppliers to a supply chain

Changed on

Add suppliers to your supply chain. Use the search suppliers endpoint to find the IDs of suppliers to add. Use default as the supply chain ID to target your organization's primary supply chain.<br><br>This endpoint does not cost credits to execute.

post/v1/supplychains/{supply_chain_id}/suppliers

Request

  • Base URL
    https://api.platform.censys.io
  • URL
    https://api.platform.censys.io/v1/supplychains/{supply_chain_id}/suppliers
  • Auth
    HTTP bearer

Path parameters

supply_chain_idstring required

The ID of a Censys supply chain, or the literal 'default' for your organization's primary supply chain. Obtain the supply chain ID using the list supply chains endpoint or from the Supplier Risk URL in the web console.

Example:11111111-2222-3333-4444-555555555555

Query parameters

organization_idstring uuid required

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information.

Example:11111111-2222-3333-4444-555555555555

Headers

X-Organization-IDstring uuid

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter.

Example:11111111-2222-3333-4444-555555555555

Request body

supplier_idsstring[] nullable required

The IDs of the Censys suppliers to add to the supply chain, each as a unique UUID string. Use the Search suppliers endpoint to find supplier IDs.

Example request

{
  "supplier_ids": [
    "11111111-2222-3333-4444-555555555555"
  ]
}

Response

Suppliers added to the supply chain successfully

Changes

    • info

      api tag Supplier Risk added

    • info

      api tag Supply Chain Intelligence removed

    • info

      for the path request parameter supply_chain_id, the format was generalized from uuid to no format

    • info

      added the non-success response with the status