Skip to main content

Add elements in bulk

POST 
/v1/lookup-lists/:lookupListId/elements/bulk-add

Adds an array of elements to an existing Lookup list and sets the expiration date for the lookup.

Request​

Path Parameters

    lookupListId stringrequired

    GUID of the lookup list.

    Example: 7c985e09-3db6-5dc6-ae33-58403493e13f

Query Parameters

    defaultTTL int64

    Optional. The expiration date and time of the lookup list as UNIX epoch milliseconds. When this parameter is left empty, the lookup list does not expire.

Body

arrayrequired
  • Array [
    • value stringrequired

    Possible values: non-empty and <= 80 characters

    A single field value.

    comment string

    Possible values: <= 200 characters

    Optional. A place to add a note or additional details about the value. For example, if the value is an IP address, the comment can identify the server.

    expirationDate int64

    Optional. The expiration date and time of the lookup list as UNIX epoch milliseconds. When this parameter is left empty, the lookup list does not expire.

  • ]

Responses​

successful operation

Response Headers
    Schema
      status string

      Possible values: [SUCCESS, PARTIAL_FAILED, FAILED]

      Returns the status of the request.

      numOfAddedElements int32

      Total number of new elements added to the Lookup list.

      numOfMergedElements int32

      Total number of elements merged with duplicate values in the existing list. (In other words, the number of existing elements that were updated by the request.)

    Loading...