REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0

Generates certificate signing request (CSR) for a certificate-record

put

https://{managementIp}/rest/{version}/configuration/certificates/generateRequest

This API allows the client to generate a certificate signing request in PKCS10 PEM format. The generated private key is stored in the certificate-record configuration element. The client making this request must already possess the configuration lock or the request fails. If one or more attributes or sub-elements in the request is syntactically invalid in any way, this request fails and the certificate-record configuration is left unmodified.

Request

Path Parameters

version(required): string

REST API version string.
Available values: v1.2

Query Parameters

reGenerate: string

Flag to indicate whether to regenerate CSR or not

Default Value: false

Allowed Values: [ true, false ]
recordName(required): string

Name of the certificate-record.

Header Parameters

Authorization(required):

The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

There's no request body for this operation.

Response

Supported Media Types

application/xml

200 Response

OK - Certificate signing request is returned in data section of the response body.

Root Schema : response

Type: object

Show Source

data(required): object data

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "CertificateRequest":{
                    "type":"object",
                    "required":[
                        "recordName",
                        "certificateSignedRequest"
                    ],
                    "properties":{
                        "recordName":{
                            "type":"string"
                        },
                        "certificateSignedRequest":{
                            "type":"string",
                            "example":"-----BEGIN CERTIFICATE REQUEST-----\n MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH\n EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz\n tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk\n -----END CERTIFICATE REQUEST-----"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Show Source

CertificateRequest: object CertificateRequest

{
    "type":"object",
    "properties":{
        "CertificateRequest":{
            "type":"object",
            "required":[
                "recordName",
                "certificateSignedRequest"
            ],
            "properties":{
                "recordName":{
                    "type":"string"
                },
                "certificateSignedRequest":{
                    "type":"string",
                    "example":"-----BEGIN CERTIFICATE REQUEST-----\n MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH\n EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz\n tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk\n -----END CERTIFICATE REQUEST-----"
                }
            }
        }
    }
}

Nested Schema : CertificateRequest

Type: object

Show Source

certificateSignedRequest(required): string

Example: -----BEGIN CERTIFICATE REQUEST----- MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk -----END CERTIFICATE REQUEST-----
recordName(required): string

{
    "type":"object",
    "required":[
        "recordName",
        "certificateSignedRequest"
    ],
    "properties":{
        "recordName":{
            "type":"string"
        },
        "certificateSignedRequest":{
            "type":"string",
            "example":"-----BEGIN CERTIFICATE REQUEST-----\n MIICzTCCAbUCAQAwVTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH\n EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEOMAwGA1UEAxMFdGVz\n tm7DBKYUNlwHXNNOwv/X54eHXskIxTcpR9aimrKpkPNt4DffotoyU6sVXHfQApAZk\n -----END CERTIFICATE REQUEST-----"
        }
    }
}

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

401 Response

Unauthorized - Request lacks valid authentication credentials.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

403 Response

This request requires the client credentials to have administrator privileges.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

404 Response

Certificate specified with recordName key attribute is not found

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

423 Response

The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is "Resource locked by another user". If no client or user owns the configuration lock, the error message is "User does not have the lock".

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

curl
Python

The following example shows how to generate a Certificate Signing Request using curl.

curl -X PUT \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/configuration/certificates/generateRequest?recordName=rest-server"

The following example shows how to generate a Certificate Signing Request using Python.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.2/configuration/certificates/generateRequest?recordName=rest-server"
resp = requests.put(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <CertificateRequest>
      <recordName>rest-server</recordName>
      <certificateSignedRequest>-----BEGIN CERTIFICATE REQUEST-----
MIIC1jCCAb4CAQAwXjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMRMwEQYDVQQH
J8pdaZzWTddSXOUMHftzx6Ix04xzYtp8NGuZ3GgB5FQbRMG2RW7sdWcvH4uUzMVm
2XfiMqWb6MnvCnk2nwGbJahV1D0/unm3QygAY8Riqua8UXevXY3p2uli4cKqrVj7
OZNU1UiS0ylVlxahxww0YPjyfWdeNKa183KQJMkd4m7f609AfUnz97teDLFMHzDP
HauJyrq7DG5YmbmTAgMBAAGgMzAxBgkqhkiG9w0BCQ4xJDAiMAsGA1UdDwQEAwIF
ZVJlc3RTZXJ2ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDo6k9j
EwpCdXJsaW5ndG9uMRQwEgYDVQQKEwtFbmdpbmVlcmluZzEXMBUGA1UEAxMOQWNt
Lk5mt/o9W7vUv38efGki8vHQIso6aZsfAcoagUejLSYy3HzXV8+ngfDQ8coUsE0D
kkhSK15DXufIJblCk25KWbeJiI413BDavNi+48WvDisKdszYZm/g45nKp4I/X3JJ
y/yqfrtrQauVidznodCsVbk+hbAcjg39bp1mWADZqdX4eUoiL+yBk7HHNrqrRpb8
IrT+OnjSiBhyqqmMkvRSpV5tomRK+VTwa9Xz50d9FTIZBPEe+gHTWiXHg1Dq9Rqb
MBjJVsVTyP0Whf6xZsRIaq5C/Ko0y3olTulyyigsXbYV7twBUwDw578DiGZ0uLXg
tkRO/9eGrpT7RFMc79gr6qnIZuorYI0FSi7ZDxXtl4fCuV5A1E4Au+gCM1s6Q50i
oDATBgNVHSUEDDAKBggrBgEFBQcDATANBgkqhkiG9w0BAQsFAAOCAQEA5wGtzGCR
e2vZqH1MWal54Yr4VwTLybija8AYkEiRPlm78go4YaNWrcKjTS7vSmZQgKziArom
8JWD3ValiNBIog==
-----END CERTIFICATE REQUEST-----
</certificateSignedRequest>
    </CertificateRequest>
  </data>
  <messages/>
  <links/>
</response>