Developer Documentation
List TLS Certificates
Returns all certificate information viewable by the user, including each certificate’s id; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/certificates
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional |
|
boolean | whether to expand the pem data and show all its details |
| optional |
|
string | Comma separated list of fields that should be included in query result |
| optional |
|
integer | Maximum number of results to return in this page (server may return fewer) |
| optional |
|
boolean | Not available |
| optional |
|
string | Field by which records are sorted |
| optional |
|
string | Type of certificate to return |
Response
Response
Response BodyResponse Body
200 OK returns
TlsCertificateList
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"children": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"description": "string",
"details": [
{
"dsa_public_key_g": "string",
"dsa_public_key_p": "string",
"dsa_public_key_q": "string",
"dsa_public_key_y": "string",
"ecdsa_curve_name": "string",
"ecdsa_ec_field": "string",
"ecdsa_ec_field_f2mks": [
0
],
"ecdsa_ec_field_f2mm": 0,
"ecdsa_ec_field_f2mrp": "string",
"ecdsa_ec_field_f2pp": "string",
"ecdsa_public_key_a": "string",
"ecdsa_public_key_b": "string",
"ecdsa_public_key_cofactor": 0,
"ecdsa_public_key_generator_x": "string",
"ecdsa_public_key_generator_y": "string",
"ecdsa_public_key_order": "string",
"ecdsa_public_key_seed": [
"string"
],
"is_ca": false,
"is_valid": false,
"issuer": "string",
"issuer_cn": "string",
"not_after": 0,
"not_before": 0,
"public_key_algo": "string",
"public_key_length": 0,
"rsa_public_key_exponent": "string",
"rsa_public_key_modulus": "string",
"serial_number": "string",
"signature": "string",
"signature_algorithm": "string",
"subject": "string",
"subject_cn": "string",
"version": "string"
}
],
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"parent_path": "string",
"path": "string",
"pem_encoded": "string",
"relative_path": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"sort_ascending": false,
"sort_by": "string"
}| Property Name | Type | Description |
|---|---|---|
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| cursor | string |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
| result_count | integer |
Count of results found (across all pages), set only on first page |
| results | array of TlsCertificate |
TlsCertificate list. |
| sort_ascending | boolean |
If true, results are sorted in ascending order |
| sort_by | string |
Field by which records are sorted |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | NotFound | The requested resource could not be found but may be available again in the future. |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
On This Page
Certificates Operations
delete
patch
