PKI CA List Certificate Requests REST API

Request

• Path: /ca/rest/agent/certrequests

• Method: GET

• Authentication: required

• Query Parameters:

  • requestState: string

  • requestType: string

  • start: dec/hex request ID

  • pageSize: integer

  • maxResults: integer

  • maxTime: integer

• Content: None

Examples

JSON

$ curl \
    -k \
    -s \
    -H "Accept: application/json" \
    --user caadmin:Secret.123 \
    https://localhost.localdomain:8443/ca/rest/agent/certrequests | python -m json.tool
{
    "total": 6,
    "entries": [
        {
            "requestType": "enrollment",
            "requestStatus": "complete",
            "requestURL": "https://localhost.localdomain:8443/ca/rest/certrequests/1",
            "certId": "0x1",
            "certURL": "https://localhost.localdomain:8443/ca/rest/certs/1",
            "certRequestType": "pkcs10",
            "operationResult": "success"
        },
        ...
    ],
    "Link": []
}

XML

$ curl \
    -k \
    -s \
    -H "Accept: application/xml" \
    --user caadmin:Secret.123 \
    https://localhost.localdomain:8443/ca/rest/agent/certrequests | xmllint --format -
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<CertDataInfos>
    <total>6</total>
    <CertDataInfo id="0x1">
        <requestType>enrollment</requestType>
        <requestStatus>complete</requestStatus>
        <requestURL>https://localhost.localdomain:8443/ca/rest/certrequests/1</requestURL>
        <certURL>https://localhost.localdomain:8443/ca/rest/certs/1</certURL>
        <certRequestType>pkcs10</certRequestType>
        <operationResult>success</operationResult>
    </CertDataInfo>
    ...
</CertDataInfos>