Venafi Configuration¶
Overview¶
Use the Venafi Configuration API to save a Venafi configuration including policy data. This API gets the policy data already stored in BIG-IQ and validates it with Venafi TPP server. If the Venafi TPP serve has additions or deletions, this API can update the BIG-IQ.
REST Endpoint: /mgmt/cm/adc-core/external-ca/venafi/config¶
Requests¶
POST /mgmt/cm/adc-core/external-ca/venafi/config¶
Send a POST request to the endpoint to save a configuration and validate it through Venafi.
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
externalCaConfigReference | object | True | Link to the CA configuration |
link | string | True | URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API. |
policyFolderPath | string | True | Path to policy folder |
applicationFolderPath | string | True | Path to application folder |
policyFolders | object | True | List of policy folders |
absoluteGUID | string | True | Policy information |
dn | string | True | Policy information |
guid | string | True | Policy information |
id | string | True | Policy information |
name | string | True | Policy information |
nickname | string | True | Policy information |
parent | string | True | Policy information |
revision | string | True | Policy information |
typeName | string | True | Policy information |
Query Parameters¶
None
Response¶
The JSON in the POST’s response can include the following parameters.
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
uuid | string | UUID of the configuration |
selfLink | string | UUID of the configuration |
policyFolders | object | List of policy folders |
absoluteGUID | string | Policy information |
dn | string | Policy information |
guid | string | Policy information |
id | string | Policy information |
name | string | Policy information |
parent | string | Policy information |
revision | string | Policy information |
typeName | string | Policy information |
externalCaConfigReference | object | Link to the CA configuration |
link | string | URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API. |
policyFolderPath | string | Path to policy folder |
applicationFolderPath | string | Path to application folder |
Permissions¶
Role | Allow |
---|---|
admin | Yes |
Certificate Editor/Viewer | No |
GET /mgmt/cm/adc-core/external-ca/venafi/config¶
Send a get to the endpoint to retrieve information for all Venafi configurations. To retrieve information for a specific configuration, append the configuration’s uuid.
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
The JSON in the body of the response can contain the following parameters.
Name | Type | Description |
---|---|---|
uuid | string | UUID of the configuration |
selfLink | string | UUID of the configuration |
policyFolders | object | List of policy folders |
absoluteGUID | string | UUID |
dn | string | Policy information |
guid | string | Policy information |
id | string | Policy information |
name | string | Policy information |
parent | string | Policy information |
revision | string | Policy information |
typeName | string | Policy information |
externalCaConfigReference | object | Link to the CA configuration |
link | string | URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API. |
policyFolderPath | string | Path to policy folder |
applicationFolderPath | string | Path to application folder |
externalCaConfigReference | object | Link to the CA configuration |
link | string | URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API. |
Permissions¶
Role | Allow |
---|---|
admin | Yes |
Certificate Editor/Viewer | Yes |
PATCH /mgmt/cm/adc-core/external-ca/venafi/config/{uuid}¶
Send a PATCH request to edit a Venafi configuration. Append the uuid of the Venafi configuration to the PATCH request.
Request Parameters¶
The body of the PATCH request can contain the configuration you want to edit.
Name | Type | Required | Description |
---|---|---|---|
policyFolders | object | True | List of policy folders |
absoluteGUID | string | True | UUID |
dn | string | True | Policy information |
guid | string | True | Policy information |
id | string | True | Policy information |
name | string | True | Policy information |
parent | string | True | Policy information |
revision | string | True | Policy information |
typeName | string | True | Policy information |
Query Parameters¶
None
Response¶
The JSON in the PATCH’s response can include the following parameters.
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
uuid | string | UUID of the configuration |
selfLink | string | UUID of the configuration |
policyFolders | object | List of policy folders |
absoluteGUID | string | UUID |
dn | string | Policy information |
guid | string | Policy information |
id | string | Policy information |
name | string | Policy information |
parent | string | Policy information |
revision | string | Policy information |
typeName | string | Policy information |
externalCaConfigReference | object | Link to the CA configuration |
link | string | URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API. |
policyFolderPath | string | Path to policy folder |
applicationFolderPath | string | Path to the application folder |
externalCaConfigReference | object | Link to the CA configuration |
link | string | URL for the CA configuration. This can be the value of the selfLink returned by the CA Configuration API. |
Permissions¶
Role | Allow |
---|---|
admin | Yes |
Certificate Editor/Viewer | No |
Examples¶
POST to save and validate a Venafi configuration¶
The following example saves a Venafi configuration and validates it through Venafi.
POST https://<BIG-IQ>/mgmt/cm/adc-core/external-ca/venafi/config
The JSON in the body of the POST request can look similar to the following example.
{
"externalCaConfigReference": {
"link": "https://localhost/mgmt/cm/adc-core/external-ca/config/7d9bf2c4-80b8-3aa0-b868-d34a8ad9b39d"
},
"policyFolderPath": "\\VED\\Policy\\certificates\\Big IQ",
"applicationFolderPath": "\\VED\\Policy\\Devices and Applications\\External\\Big-IQ",
"policyFolders": [{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security(Locked)",
"guid": "{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"id": "3222",
"name": "Venafi Generated CSR Medium Security(Locked)",
"nickName": "Venafi Generated CSR Medium Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149142176",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security",
"guid": "{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"id": "3226",
"name": "Venafi Generated CSR High Security",
"nickName": "Venafi Generated CSR High Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149629275",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security(Locked)",
"guid": "{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"id": "3225",
"name": "Venafi Generated CSR Low Security(Locked)",
"nickName": "Venafi Generated CSR Low Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112652",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security(Locked)",
"guid": "{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"id": "3224",
"name": "Venafi Generated CSR High Security(Locked)",
"nickName": "Venafi Generated CSR High Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112584",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\BigIQ Generated CSR",
"guid": "{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"id": "3214",
"name": "BigIQ Generated CSR",
"nickName": "BigIQ Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885150032325",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR",
"guid": "{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"id": "3216",
"name": "Venafi Generated CSR",
"nickName": "Venafi Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149946045",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{45df3468-c577-4357-8441-019d1e0482b1}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security",
"guid": "{45df3468-c577-4357-8441-019d1e0482b1}",
"id": "3220",
"name": "Venafi Generated CSR Medium Security",
"nickName": "Venafi Generated CSR Medium Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149201716",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{b816e23e-8b32-486d-b339-488f737595ed}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security",
"guid": "{b816e23e-8b32-486d-b339-488f737595ed}",
"id": "3227",
"name": "Venafi Generated CSR Low Security",
"nickName": "Venafi Generated CSR Low Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112379",
"typeName": "Policy"
}
]
}
Response¶
The JSON in the body of the POST response can look similar to the following example.
HTTP/1.1 200 OK
{
"kind": "cm:adc-core:external-ca:venafi:config:venaficonfigstate",
"uuid": "4a611f7f-42a9-3743-8b9f-936dc8fcfbc2",
"selfLink": "https://localhost/mgmt/cm/adc-core/external-ca/venafi/config/4a611f7f-42a9-3743-8b9f-936dc8fcfbc2",
"generation": 1,
"policyFolders": [{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security(Locked)",
"id": "3222",
"guid": "{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"name": "Venafi Generated CSR Medium Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Medium Security(Locked)",
"revision": "636747885149142176",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security",
"id": "3226",
"guid": "{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"name": "Venafi Generated CSR High Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR High Security",
"revision": "636747885149629275",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{da8deecb-5f8f-4c8e-a3e8-201310e36305}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security(Locked)",
"id": "3225",
"guid": "{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"name": "Venafi Generated CSR Low Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Low Security(Locked)",
"revision": "636747885149112652",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security(Locked)",
"id": "3224",
"guid": "{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"name": "Venafi Generated CSR High Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR High Security(Locked)",
"revision": "636747885149112584",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{9f5660dc-787d-49b6-80a0-d55a1c0c4197}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\BigIQ Generated CSR",
"id": "3214",
"guid": "{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"name": "BigIQ Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "BigIQ Generated CSR",
"revision": "636747885150032325",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR",
"id": "3216",
"guid": "{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"name": "Venafi Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR",
"revision": "636747885149946045",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security",
"id": "3220",
"guid": "{45df3468-c577-4357-8441-019d1e0482b1}",
"name": "Venafi Generated CSR Medium Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Medium Security",
"revision": "636747885149201716",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{45df3468-c577-4357-8441-019d1e0482b1}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security",
"id": "3227",
"guid": "{b816e23e-8b32-486d-b339-488f737595ed}",
"name": "Venafi Generated CSR Low Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Low Security",
"revision": "636747885149112379",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{b816e23e-8b32-486d-b339-488f737595ed}"
}
],
"lastUpdateMicros": 1595503446572755,
"policyFolderPath": "\\VED\\Policy\\certificates\\Big IQ",
"applicationFolderPath": "\\VED\\Policy\\Devices and Applications\\External\\Big-IQ",
"externalCaConfigReference": {
"link": "https://localhost/mgmt/cm/adc-core/external-ca/config/7d9bf2c4-80b8-3aa0-b868-d34a8ad9b39d"
}
}
GET to retrieve all Venafi configurations¶
The following example retrieves all the Venafi configurations saved on the BIG-IQ.
GET https://<BIG-IQ>/mgmt/cm/adc-core/external-ca/venafi/config
Response¶
The JSON in the GET’s response can look similar to the following example.
{
"kind": "cm:adc-core:external-ca:venafi:config:venaficonfigstate",
"uuid": "4a611f7f-42a9-3743-8b9f-936dc8fcfbc2",
"selfLink": "https://localhost/mgmt/cm/adc-core/external-ca/venafi/config/4a611f7f-42a9-3743-8b9f-936dc8fcfbc2",
"generation": 1,
"policyFolders": [{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security(Locked)",
"id": "3222",
"guid": "{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"name": "Venafi Generated CSR Medium Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Medium Security(Locked)",
"revision": "636747885149142176",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security",
"id": "3226",
"guid": "{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"name": "Venafi Generated CSR High Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR High Security",
"revision": "636747885149629275",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{da8deecb-5f8f-4c8e-a3e8-201310e36305}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security(Locked)",
"id": "3225",
"guid": "{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"name": "Venafi Generated CSR Low Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Low Security(Locked)",
"revision": "636747885149112652",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security(Locked)",
"id": "3224",
"guid": "{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"name": "Venafi Generated CSR High Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR High Security(Locked)",
"revision": "636747885149112584",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{9f5660dc-787d-49b6-80a0-d55a1c0c4197}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\BigIQ Generated CSR",
"id": "3214",
"guid": "{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"name": "BigIQ Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "BigIQ Generated CSR",
"revision": "636747885150032325",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR",
"id": "3216",
"guid": "{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"name": "Venafi Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR",
"revision": "636747885149946045",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security",
"id": "3220",
"guid": "{45df3468-c577-4357-8441-019d1e0482b1}",
"name": "Venafi Generated CSR Medium Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Medium Security",
"revision": "636747885149201716",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{45df3468-c577-4357-8441-019d1e0482b1}"
},
{
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security",
"id": "3227",
"guid": "{b816e23e-8b32-486d-b339-488f737595ed}",
"name": "Venafi Generated CSR Low Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"nickName": "Venafi Generated CSR Low Security",
"revision": "636747885149112379",
"typeName": "Policy",
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{b816e23e-8b32-486d-b339-488f737595ed}"
}
],
"lastUpdateMicros": 1595503446572755,
"policyFolderPath": "\\VED\\Policy\\certificates\\Big IQ",
"applicationFolderPath": "\\VED\\Policy\\Devices and Applications\\External\\Big-IQ",
"externalCaConfigReference": {
"link": "https://localhost/mgmt/cm/adc-core/external-ca/config/7d9bf2c4-80b8-3aa0-b868-d34a8ad9b39d"
}
}
PATCH to edit a Venafi configuration¶
The following example edits a Venafi configuration with the changed configuration information in the body of the PATCH.
PATCH https://<BIG-IQ>/mgmt/cm/adc-core/external-ca/venafi/config/4a611f7f-42a9-3743-8b9f-936dc8fcfbc2
The JSON in the body of the PATCH can look similar to the following example.
{
"policyFolders": [{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security(Locked)",
"guid": "{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"id": "3222",
"name": "Venafi Generated CSR Medium Security(Locked)",
"nickName": "Venafi Generated CSR Medium Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149142176",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security",
"guid": "{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"id": "3226",
"name": "Venafi Generated CSR High Security",
"nickName": "Venafi Generated CSR High Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149629275",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security(Locked)",
"guid": "{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"id": "3225",
"name": "Venafi Generated CSR Low Security(Locked)",
"nickName": "Venafi Generated CSR Low Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112652",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security(Locked)",
"guid": "{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"id": "3224",
"name": "Venafi Generated CSR High Security(Locked)",
"nickName": "Venafi Generated CSR High Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112584",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\BigIQ Generated CSR",
"guid": "{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"id": "3214",
"name": "BigIQ Generated CSR",
"nickName": "BigIQ Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885150032325",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR",
"guid": "{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"id": "3216",
"name": "Venafi Generated CSR",
"nickName": "Venafi Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149946045",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{45df3468-c577-4357-8441-019d1e0482b1}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security",
"guid": "{45df3468-c577-4357-8441-019d1e0482b1}",
"id": "3220",
"name": "Venafi Generated CSR Medium Security",
"nickName": "Venafi Generated CSR Medium Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149201716",
"typeName": "Policy"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{b816e23e-8b32-486d-b339-488f737595ed}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security",
"guid": "{b816e23e-8b32-486d-b339-488f737595ed}",
"id": "3227",
"name": "Venafi Generated CSR Low Security",
"nickName": "Venafi Generated CSR Low Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112379",
"typeName": "Policy"
}
]
}
Response¶
HTTP/1.1 200 OK
{
"uuid": "4a611f7f-42a9-3743-8b9f-936dc8fcfbc2",
"policyFolderPath": "\\VED\\Policy\\certificates\\Big IQ",
"applicationFolderPath": "\\VED\\Policy\\Devices and Applications\\External\\Big-IQ",
"externalCaConfigReference": {
"link": "https://localhost/mgmt/cm/adc-core/external-ca/config/7d9bf2c4-80b8-3aa0-b868-d34a8ad9b39d"
},
"policyFolders": [{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{45df3468-c577-4357-8441-019d1e0482b1}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security",
"guid": "{45df3468-c577-4357-8441-019d1e0482b1}",
"id": "3220",
"name": "Venafi Generated CSR Medium Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149201716",
"typeName": "Policy",
"nickName": "Venafi Generated CSR Medium Security"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security",
"guid": "{da8deecb-5f8f-4c8e-a3e8-201310e36305}",
"id": "3226",
"name": "Venafi Generated CSR High Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149629275",
"typeName": "Policy",
"nickName": "Venafi Generated CSR High Security"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security(Locked)",
"guid": "{c29d0516-6efd-4d5a-8e6a-6fb5f8b718f6}",
"id": "3225",
"name": "Venafi Generated CSR Low Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112652",
"typeName": "Policy",
"nickName": "Venafi Generated CSR Low Security(Locked)"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Medium Security(Locked)",
"guid": "{7cdb4598-dcbc-4ad1-b52a-55b42f2fd71e}",
"id": "3222",
"name": "Venafi Generated CSR Medium Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149142176",
"typeName": "Policy",
"nickName": "Venafi Generated CSR Medium Security(Locked)"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR",
"guid": "{3c0a0cfd-f555-4d3a-abae-f4a5b8e86b86}",
"id": "3216",
"name": "Venafi Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149946045",
"typeName": "Policy",
"nickName": "Venafi Generated CSR"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR High Security(Locked)",
"guid": "{9f5660dc-787d-49b6-80a0-d55a1c0c4197}",
"id": "3224",
"name": "Venafi Generated CSR High Security(Locked)",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112584",
"typeName": "Policy",
"nickName": "Venafi Generated CSR High Security(Locked)"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{b816e23e-8b32-486d-b339-488f737595ed}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\Venafi Generated CSR Low Security",
"guid": "{b816e23e-8b32-486d-b339-488f737595ed}",
"id": "3227",
"name": "Venafi Generated CSR Low Security",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885149112379",
"typeName": "Policy",
"nickName": "Venafi Generated CSR Low Security"
},
{
"absoluteGUID": "{798ee447-74f4-4c8a-8972-62aff3b2fee3}{266d63f4-0bfc-468a-b41f-d8fa477bd1c0}{5020eaa0-1de7-4be4-bfe8-fbcb7e948502}{2c455b33-7c53-4db1-acdf-62e7f226c469}{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"dn": "\\VED\\Policy\\Certificates\\Big IQ\\BigIQ Generated CSR",
"guid": "{7b0dceaf-99fb-4e12-b08b-9f21405e9ea8}",
"id": "3214",
"name": "BigIQ Generated CSR",
"parent": "\\VED\\Policy\\Certificates\\Big IQ",
"revision": "636747885150032325",
"typeName": "Policy",
"nickName": "BigIQ Generated CSR"
}
],
"generation": 2,
"lastUpdateMicros": 1595504756461324,
"kind": "cm:adc-core:external-ca:venafi:config:venaficonfigstate",
"selfLink": "https://localhost/mgmt/cm/adc-core/external-ca/venafi/config/4a611f7f-42a9-3743-8b9f-936dc8fcfbc2"
}