REST API for Oracle SD-WAN Edge Release 9.1.1

Build certificate information

get

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/https_settings/buildCertificateInfo

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedGet

Type: object

Show Source

message: string

Example: Operation must use a GET
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a GET"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to get the HTTPS certificate information by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X GET \
    -b cookies.txt \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/https_settings/buildCertificateInfo"

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": {
    "/etc/httpd/ssl/talari.crt": {
      "expDate": "Jun 29 15:22:40 2023 GMT",
      "fingerprint": "D6:4C:D2:82:24:60:CC:83:BE:AE:6E:91:12:2B:D1:A9:B1:EF:4D:3E",
      "issuer": "/C=US/ST=California/L=San Jose/O=Talari Networks, Inc./OU=Engineering/CN=Talari/emailAddress=supportattalari.com",
      "path": "/etc/httpd/ssl/talari.crt",
      "serial": "E9470F765F6F015A",
      "startDate": "Jun 29 15:22:40 2020 GMT",
      "subject": "/C=US/ST=California/L=San Jose/O=Talari Networks, Inc./OU=Engineering/CN=Talari/emailAddress=supportattalari.com"
    }
  },
  "status": "success"
}