>
    Query Verdicts
    Focus
    Download PDF
    Focus
    1. Home
    2. Prisma Access
    3. Prisma Access User-Based Policy
    4. Third-Party Device-ID APIs
    5. Query Verdicts
    Download PDF
    Prisma Access

    Query Verdicts

    Table of Contents

    Query Verdicts

    Retrieves the IP address-to-device mappings in the Third-Party Device-ID service.

    Synopsis

    URI/api/v1/token/{apiKey}/verdicts?bookmark={STRING}&pageLen={INTEGER}
    HTTP MethodGET

    Description

    Returns either all mappings or a subset.
    To return all mappings, send the request once without any parameters. Take note of the nextBookmark value in the response. Send another request using that value for bookmark appended to the URI. The caller will repeat the query until count is empty in the response, indicating that it has returned all mappings.
    To return a subset of mappings, specify the number of mappings you want to retrieve using pageLen, up to 10000.

    Parameters

    This API accepts these parameters:
    ParameterDescription
    bookmark(Optional) Used after the first request to return all mappings.
    pageLen(Optional) The number of mappings to retrieve. Range is 1-10000. If left unspecified, the default value is 10000.

    Success Response

    Upon success, the HTTP response code is 200. In addition, the response contains a JSON object with the following fields:
    FieldDescription
    nextBookmarkThe value you use in the bookmark parameter to perform repeated queries until all mappings are returned.
    countInteger representing the number of mappings returned in the response.
    verdicts
    Object that contains the mappings specified in the request.
    For example:
    {
    "nextBookmark": CkcKVxdWVuY2USAggEEjFqCHN,        
    "count": 1,
    "verdicts" : [
        {   
            "ip": "10.10.10.10",
            "updateTime": 1623974506,
            "mac": "0a:d4:5f:e9:96:10",
            "category": "Smartphone or Tablet",
            "vendor": "Apple Inc.",
            "model": "iPad2",
            "os": "iOS 9.3.6",
            "osFamily": "iOS",
            "profile": "iPad"
        }
    ]
}
}

    Error Response

    Upon error, the HTTP response code is one of the following:
    Response CodeDescription
    400
    Invalid request. The request was incomplete or malformed in some way.
    You should fix the request before retrying.
    401Unauthorized token.
    429 Too many requests. The request could not be processed because too many requests have been issued in a specific period of time. No more than one request per second is allowed. Please wait and try again.
    In addition, the response body contains the following fields:
    Field
    Description
    codeThe error code.
    messageThe error message.

    © 2024 Palo Alto Networks, Inc. All rights reserved.