SSL Keys¶
Overview¶
This document describes the API to retrieve information about SSL Key objects.
REST Endpoint: /mgmt/cm/adc-core/working-config/sys/file/ssl-key¶
Requests¶
GET /mgmt/cm/adc-core/working-config/sys/file/ssl-key/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
checksum | string | The checksum of the file data. |
createDateTime | string | Date and time that the object was created. Only used and updated by BIG-IP. |
createdBy | string | The user that created the key object. Only used and updated by BIG-IP. |
curveName | string | For an eliptical curve key, this is the name of the curve. Possible values include “prime256v1”, “secp384r1”, “secp521r1”, or “none” if the key type is not eliptical curve. |
fileReference | object | A reference to the object representing the file data. |
fingerprint | string | The fingerprint of the public portion of the key. |
groupingKey | string | A token that identifies related objects of different types, for internal use. |
id | string | Unique identifier for this collection item. |
keySize | number | For a RSA or DSA key, this is the size of the key in bits. |
keyType | string | The type of the key. Possible values include “rsa-private”, “rsa-public”, “dsa-private”, “dsa-public”, “ec-private”, and “ec-public”. |
lastUpdateDateTime | string | Date and time of the most recent update to this object. Only used and updated by BIG-IP. |
mode | number | Numeric UNIX permissions for the file. Traditionally these values are represented in octal, but this field is a JSON number with no inherent formatting. Only used and updated by BIG-IP. |
passphrase | string | For an encrypted key, this is the encryption passphrase, given in an encrypted form. |
revision | number | File revision, incremented with each update. Only used and updated by BIG-IP. |
securityType | string | The type of security for this key. Possible values include “normal”, “fips”, “password”, and “nethsm”. |
size | number | Size of the file in bytes. |
sourcePath | string | Original location from which the file was imported. Only used and updated by BIG-IP. |
systemPath | string | Optional location of the file on the BIG-IP file system. Only used and updated by BIG-IP. |
updatedBy | string | User that updated this object most recently. Only used and updated by BIG-IP. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
Access_Deploy | Yes |
Access_Edit | Yes |
Service_Catalog_Viewer | Yes |
ADC_Manager | Yes |
Access_View | Yes |
Service_Catalog_Editor | Yes |
Access_Policy_Editor | Yes |
Access_Manager | Yes |
ADC_Deployer | Yes |
Application_Viewer | Yes |
ADC_Editor | Yes |
Trust_Discovery_Import | Yes |
ADC_Viewer | Yes |
Application_Manager | Yes |
DELETE /mgmt/cm/adc-core/working-config/sys/file/ssl-key/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
checksum | string | The checksum of the file data. |
createDateTime | string | Date and time that the object was created. Only used and updated by BIG-IP. |
createdBy | string | The user that created the key object. Only used and updated by BIG-IP. |
curveName | string | For an eliptical curve key, this is the name of the curve. Possible values include “prime256v1”, “secp384r1”, “secp521r1”, or “none” if the key type is not eliptical curve. |
fileReference | object | A reference to the object representing the file data. |
fingerprint | string | The fingerprint of the public portion of the key. |
groupingKey | string | A token that identifies related objects of different types, for internal use. |
id | string | Unique identifier for this collection item. |
keySize | number | For a RSA or DSA key, this is the size of the key in bits. |
keyType | string | The type of the key. Possible values include “rsa-private”, “rsa-public”, “dsa-private”, “dsa-public”, “ec-private”, and “ec-public”. |
lastUpdateDateTime | string | Date and time of the most recent update to this object. Only used and updated by BIG-IP. |
mode | number | Numeric UNIX permissions for the file. Traditionally these values are represented in octal, but this field is a JSON number with no inherent formatting. Only used and updated by BIG-IP. |
passphrase | string | For an encrypted key, this is the encryption passphrase, given in an encrypted form. |
revision | number | File revision, incremented with each update. Only used and updated by BIG-IP. |
securityType | string | The type of security for this key. Possible values include “normal”, “fips”, “password”, and “nethsm”. |
size | number | Size of the file in bytes. |
sourcePath | string | Original location from which the file was imported. Only used and updated by BIG-IP. |
systemPath | string | Optional location of the file on the BIG-IP file system. Only used and updated by BIG-IP. |
updatedBy | string | User that updated this object most recently. Only used and updated by BIG-IP. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | No |
Access_Deploy | No |
Access_Edit | No |
Service_Catalog_Viewer | No |
ADC_Manager | Yes |
Access_View | No |
Service_Catalog_Editor | No |
Access_Policy_Editor | No |
Access_Manager | No |
ADC_Deployer | No |
Application_Viewer | No |
ADC_Editor | Yes |
Trust_Discovery_Import | No |
ADC_Viewer | No |
Application_Manager | No |
Examples¶
List a SSL Key’s properties¶
GET /mgmt/cm/adc-core/working-config/sys/file/ssl-key/<id>
Response¶
HTTP/1.1 200 OK
{
"checksum": "SHA1:1834:63f52c994eaeee846abad4fb0ae3eae3daed24df",
"createDateTime": "2018-05-23T19:06:49.000Z",
"createdBy": "root",
"curveName": "none",
"fileReference": {
"link": "https://localhost/mgmt/cm/adc-core/working-config/file-objects/17ba6736-29b2-485b-8137-30556e2aa222"
},
"fingerprint": "bfea2771d6414a56fa4447860878506e",
"generation": 2,
"groupingKey": "/Common/example.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "3d94e175-f832-3602-8f2c-53005ebea891",
"keySize": 2048,
"keyType": "rsa-private",
"kind": "cm:adc-core:working-config:sys:file:ssl-key:adcsslkeystate",
"lastUpdateDateTime": "2018-05-23T19:06:49.000Z",
"lastUpdateMicros": 1527103516377320,
"mode": 33184,
"name": "example.key",
"partition": "Common",
"passphrase": "17sBKi0uY3YFOtEE4emxEXWAXRl7KRKR8MWJ1TYB1o0=",
"revision": 1,
"securityType": "password",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-key/3d94e175-f832-3602-8f2c-53005ebea891",
"size": 1834,
"sourcePath": "file:/root/example.key",
"updatedBy": "root"
}
List all SSL Keys’ properties¶
GET /mgmt/cm/adc-core/working-config/sys/file/ssl-key
Response¶
HTTP/1.1 200 OK
{
"generation": 11,
"items": [
{
"fingerprint": "/Common/default_fingerprint",
"generation": 1,
"groupingKey": "/Common/default.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "efd7cd97-43ff-3fcd-8414-e16d2c7a9fbc",
"kind": "cm:adc-core:working-config:sys:file:ssl-key:adcsslkeystate",
"lastUpdateMicros": 1527015639417788,
"name": "default.key",
"partition": "Common",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-key/efd7cd97-43ff-3fcd-8414-e16d2c7a9fbc"
},
{
"checksum": "SHA1:1834:63f52c994eaeee846abad4fb0ae3eae3daed24df",
"createDateTime": "2018-05-23T19:06:49.000Z",
"createdBy": "root",
"curveName": "none",
"fileReference": {
"link": "https://localhost/mgmt/cm/adc-core/working-config/file-objects/17ba6736-29b2-485b-8137-30556e2aa222"
},
"fingerprint": "bfea2771d6414a56fa4447860878506e",
"generation": 2,
"groupingKey": "/Common/example.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "3d94e175-f832-3602-8f2c-53005ebea891",
"keySize": 2048,
"keyType": "rsa-private",
"kind": "cm:adc-core:working-config:sys:file:ssl-key:adcsslkeystate",
"lastUpdateDateTime": "2018-05-23T19:06:49.000Z",
"lastUpdateMicros": 1527103516377320,
"mode": 33184,
"name": "example.key",
"partition": "Common",
"passphrase": "17sBKi0uY3YFOtEE4emxEXWAXRl7KRKR8MWJ1TYB1o0=",
"revision": 1,
"securityType": "password",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-key/3d94e175-f832-3602-8f2c-53005ebea891",
"size": 1834,
"sourcePath": "file:/root/example.key",
"updatedBy": "root"
},
],
"kind": "cm:adc-core:working-config:sys:file:ssl-key:adcsslkeycollectionstate",
"lastUpdateMicros": 1527103516389628,
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-key"
}
Delete a SSL Key¶
DELETE /mgmt/cm/adc-core/working-config/sys/file/ssl-key/<id>
Response¶
HTTP/1.1 200 OK
{
"checksum": "SHA1:1834:63f52c994eaeee846abad4fb0ae3eae3daed24df",
"createDateTime": "2018-05-23T19:06:49.000Z",
"createdBy": "root",
"curveName": "none",
"fileReference": {
"link": "https://localhost/mgmt/cm/adc-core/working-config/file-objects/17ba6736-29b2-485b-8137-30556e2aa222"
},
"fingerprint": "bfea2771d6414a56fa4447860878506e",
"generation": 2,
"groupingKey": "/Common/example.grouping-suffix-50453eb1-4c24-481f-b4eb-30ac613aace7",
"id": "3d94e175-f832-3602-8f2c-53005ebea891",
"keySize": 2048,
"keyType": "rsa-private",
"kind": "cm:adc-core:working-config:sys:file:ssl-key:adcsslkeystate",
"lastUpdateDateTime": "2018-05-23T19:06:49.000Z",
"lastUpdateMicros": 1527104633152210,
"mode": 33184,
"name": "example.key",
"partition": "Common",
"passphrase": "17sBKi0uY3YFOtEE4emxEXWAXRl7KRKR8MWJ1TYB1o0=",
"revision": 1,
"securityType": "password",
"selfLink": "https://localhost/mgmt/cm/adc-core/working-config/sys/file/ssl-key/3d94e175-f832-3602-8f2c-53005ebea891",
"size": 1834,
"sourcePath": "file:/root/example.key",
"updatedBy": "root"
}