Skip to content
/
Upload the Certificate

Certificate Template API (0.0.1)

Download OpenAPI description
Download PDF
Languages
Servers
Asia Server URL
https://api.asia.ruckus.cloud/
Europe Server URL
https://api.eu.ruckus.cloud/
North America Server URL
https://api.ruckus.cloud/

Certificate Authority

APIs for Certificate Authority Management.

Operations

Server and Client Certificate

APIs for Server and Client Certificate Management.

Operations

Get Specific Certificate

Request

Path
certIdstringrequired

Certificate id

No request payload

Responses

Certificate

Body
Response
No response example

Download the Private KEY of Certificate

Request

Path
certIdstringrequired

Certificate id

Bodyapplication/jsonrequired
passwordstring

The password to use to encrypt the private key. If encryption is not required, please leave it blank.

includeChainboolean
application/json
{
  "password": "string",
  "includeChain": true
}

Responses

Downloaded private key of CA

Bodyapplication/x-pkcs12

Delete a Certificate

Request

Path
certIdstringrequired

Certificate id

No request payload

Responses

The delete request has been accepted and is in progress.

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Update the Certificate

Request

Path
certIdstringrequired

Certificate id

Body
required
namestring[ 2 .. 255 ] characters

The name for the certificate.

revocationReasonstring[ 0 .. 255 ] characters

The reason for revocation of passphrase. If not revoked, this field should be null.

descriptionstring[ 0 .. 255 ] characters

The description of this certificate.

notAfterDatestring(date-time)

The expiration date for the renewed certificate. The start date for the validity period will also be set to today.

{
  "name": "string",
  "revocationReason": "string",
  "description": "string",
  "notAfterDate": "2019-08-24T14:15:22Z"
}

Responses

The update request has been accepted and is in progress.

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates Matching Search String in Paged Result

Request

Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
searchStringstring
filtersobject(CertFilters)
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID",
    "extendedKeyUsages": [ … ],
    "keyUsages": [ … ]
  }
}

Responses

Certificate

Body
fieldsArray of strings
totalCountinteger(int64)
totalPagesinteger(int32)
pageinteger(int32)
dataArray of objects(CertificateDto)

Certificate in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Upload the Certificate

Request

Bodymultipart/form-data
certificateFilestring(binary)required

The certificate in P12, DER or PEM format be uploaded.

privateKeyFilestring(binary)

The private key in PEM format be uploaded.

passwordstring

If private key or key store is password-protected, specify the password. If not, leave the password blank.

namestringrequired

The name for the certificate.

multipart/form-data
{
  "certificateFile": "string",
  "privateKeyFile": "string",
  "password": "string",
  "name": "string"
}

Responses

The upload request has been accepted and is in progress.

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Search for Certificates Issued by Specific Certificate Authority Matching Search String in Paged Result

Request

Path
caIdstringrequired

Certificate Authority id

Bodyapplication/jsonrequired
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
searchStringstring
filtersobject(CertFilters)
application/json
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID",
    "extendedKeyUsages": [ … ],
    "keyUsages": [ … ]
  }
}

Responses

Server or Client Certificate

Body
fieldsArray of strings
totalCountinteger(int64)
totalPagesinteger(int32)
pageinteger(int32)
dataArray of objects(CertificateDto)

Certificate in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Create Certificate

Request

Path
caIdstringrequired

Certificate Authority id

Body
required
namestring[ 2 .. 255 ] charactersrequired

The name of the certificate.

commonNamestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The common name of the certificate.

notBeforeDatestring(date-time)required

The start date of the certificate.

notAfterDatestring(date-time)required

The expires date of the certificate.

emailstring[ 0 .. 255 ] characters^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email of the certificate.

titlestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The title for the certificate authority.

revocationReasonstring

Reason for revocation of certificate.

organizationstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The organization of the certificate.

keyLengthinteger(int32)[ 2048 .. 4096 ]required

The length of the key.

localitystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The locality included in the certificate.

statestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The state included in the certificate.

countrystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The country included in the certificate.

organizationUnitstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The organization unit of the certificate.

keyUsagesArray of strings

The key usages of the certificate.

Items Enum"DIGITAL_SIGNATURE""KEY_ENCIPHERMENT"
descriptionstring

The description of the certificate.

algorithmstring(AlgorithmEnum)required

SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.

Enum"SHA_1""SHA_256""SHA_384""SHA_512"
csrStringstringwrite-only

The certificate signing request that should be signed by the CA.

extendedKeyUsagesArray of strings

The extended key usage of the certificate.

Items Enum"SERVER_AUTH""CLIENT_AUTH"
{
  "name": "string",
  "commonName": "string",
  "notBeforeDate": "2019-08-24T14:15:22Z",
  "notAfterDate": "2019-08-24T14:15:22Z",
  "email": "string",
  "title": "string",
  "revocationReason": "string",
  "organization": "string",
  "keyLength": 2048,
  "locality": "string",
  "state": "string",
  "country": "string",
  "organizationUnit": "string",
  "keyUsages": [
    "DIGITAL_SIGNATURE"
  ],
  "description": "string",
  "algorithm": "SHA_1",
  "csrString": "string",
  "extendedKeyUsages": [
    "SERVER_AUTH"
  ]
}

Responses

Certificate created

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Download Certificate Chain

Request

Path
certIdstringrequired

Certificate id

No request payload

Responses

Downloaded certificate in chain.

Bodyapplication/x-pkcs7-certificates

Get Certificates Associated with RADIUS

Request

Path
radiusProfileIdstringrequired

Radius id

Query
certTypestringrequired
Enum"SERVER""CLIENT"
pageableobject(Pageable)required

parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
No request payload

Responses

Certificate

Body
idstringread-only

The unique for this certificate.

namestring[ 2 .. 255 ] charactersrequired

The name of the certificate.

commonNamestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The common name of the certificate.

createDatestring(date-time)read-only

The date that creates the certificate.

notBeforeDatestring(date-time)required

The start date of the certificate.

notAfterDatestring(date-time)required

The expires date of the certificate.

emailstring[ 0 .. 255 ] characters^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

The email of the certificate.

titlestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The title for the certificate authority.

revocationDatestring(date-time)read-only

The date after which the certificate be revoked.

revocationReasonstring

Reason for revocation of certificate.

serialNumberstringread-only

The serial number of the certificate.

shaThumbprintstringread-only

The thumbprint of the certificate.

publicKeyBase64stringread-only

The public key of the certificate.

organizationstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The organization of the certificate.

keyLengthinteger(int32)[ 2048 .. 4096 ]required

The length of the key.

certificateAuthorityNamestringread-only

The name of the certificate authority that issued this certificate.

localitystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The locality included in the certificate.

statestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The state included in the certificate.

countrystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The country included in the certificate.

organizationUnitstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The organization unit of the certificate.

keyUsagesArray of strings

The key usages of the certificate.

Items Enum"DIGITAL_SIGNATURE""KEY_ENCIPHERMENT"
privateKeyBase64stringread-only

The private key of the certificate.

chainstringread-only

The chain of the certificate.

detailsstringread-only

The details of the certificate.

descriptionstring

The description of the certificate.

algorithmstring(AlgorithmEnum)required

SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.

Enum"SHA_1""SHA_256""SHA_384""SHA_512"
statusArray of stringsread-only

The status of the certificate.

Items Enum"INVALID""VALID""REVOKED""EXPIRED"
extendedKeyUsagesArray of strings

The extended key usage of the certificate.

Items Enum"SERVER_AUTH""CLIENT_AUTH"
Response
{
  "id": "string",
  "name": "string",
  "commonName": "string",
  "createDate": "2019-08-24T14:15:22Z",
  "notBeforeDate": "2019-08-24T14:15:22Z",
  "notAfterDate": "2019-08-24T14:15:22Z",
  "email": "string",
  "title": "string",
  "revocationDate": "2019-08-24T14:15:22Z",
  "revocationReason": "string",
  "serialNumber": "string",
  "shaThumbprint": "string",
  "publicKeyBase64": "string",
  "organization": "string",
  "keyLength": 2048,
  "certificateAuthorityName": "string",
  "locality": "string",
  "state": "string",
  "country": "string",
  "organizationUnit": "string",
  "keyUsages": [
    "DIGITAL_SIGNATURE"
  ],
  "privateKeyBase64": "string",
  "chain": "string",
  "details": "string",
  "description": "string",
  "algorithm": "SHA_1",
  "status": [
    "INVALID"
  ],
  "extendedKeyUsages": [
    "SERVER_AUTH"
  ]
}

Device Certificate

APIs for Device Certificate Management.

Operations

Certificate Template

APIs for Certificate Template Management.

Operations