Adds, modifies, or deletes IP address-to-device mappings.
Synopsis
URI
/api/v1/token/{apiKey}/verdicts:update
HTTP Method
POST
Description
Third-Party Device-ID ingests data from third-party IoT detection sources
in your network and creates IP address-to-device mappings that Prisma Access can use
to enforce device-specific Security policy rules. Use this API to add a new mapping,
modify an existing mapping, or delete a mapping.
You add or modify a mapping using the update
field, and you delete a mapping using the delete
field.
If the mapping already exists, update
overwrites existing device attributes with the attributes specified in the request
body. If the mapping does not exist, update creates the new mapping.
This API does not support partial updates. If you want to update specific
attributes of a mapping, you must also re-enter the previous values for the
attributes that you don't want to update. Leaving attributes blank will erase
existing values.
You can update or delete up to 10,000 mappings at a time. The request is
atomic: a successful response means the system processed everything, and a failure
response means the system processed nothing.
Fields
Field
Description
update
A JSON object that provides
the attributes of an IP address-to-device mapping that you either
want to update or create. Must have ip and at least one other
attribute populated.
delete
A JSON object that specifies the IP address of the
mapping you want to delete.
Upon success, the HTTP response code is 200. In addition, the response contains a
JSON object with the following field:
Field
Description
updateTime
A unix timestamp that represents when the request succeeded.
For example:
{
"updateTime": unix-timestamp
}
Error Response
Upon error, the HTTP response code is one of the following:
Response Code
Description
400
Invalid Request. The request was incomplete or malformed in some
way. Fix the request before retrying.
401
Unauthorized token. Try regenerating your API token.
If that doesn’t work, contact support.
409
Conflict. The request couldn’t be processed because
there is another ongoing update or delete job. Try again after the
other job finishes.
429
Too many requests. The request couldn’t be processed
because the system has issued too many requests in a specific period
of time. Do not exceed more than one request per second. Wait and
try again.
In addition, the response body contains the following fields:
xThanks for visiting https://docs.paloaltonetworks.com. To improve your experience when accessing content across our site, please add the domain to the allow list on your ad blocker application.