Skip to main content

Retrieve a CA certificate configured for IPpsec

Contributors
PDFs

GET /security/ipsec/ca-certificates/{certificate.uuid}

Introduced In: 9.10

Retrieves a specific CA certificate configured for IPsec.

  • security ipsec ca-certificate show

Parameters

Name Type In Required Description

certificate.uuid

string

path

True

UUID of the IPsec CA certificate.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

certificate

certificate

IPsec CA certificate UUID

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "scope": "svm",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

certificate

IPsec CA certificate UUID

Name Type Description

_links

_links

uuid

string

Certificate UUID

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.