Get Sdrouting Certificate Features - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Sdrouting Certificate Features","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/f75de7c3-5553-375b-b45f-644916a52d4b","info":{"title":"Feature Profiles - SD-Routing","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in SD-Routing Solution\n- Supporting software-defined routing features and autonomous router management\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing certificate features from a specific system feature profile","operationId":"GetSdroutingCertificateFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef","description":"Set the feature name"},"description":{"description":"Set the feature description","type":"string"},"data":{"type":"object","properties":{"certificates":{"description":"Thirdparty CA Certificate List","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"trustPointName":{"description":"Trust Point Name of Certificate","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"maxLength":32,"type":"string","pattern":"(^([a-zA-Z])([a-zA-Z0-9_-])+)$"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfTrustpointNameOptionDef"},"certificateUUID":{"description":"UUID of Certificate Record in Database","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfCertificateUUIDOptionDef"}},"required":["trustPointName","certificateUUID"],"additionalProperties":false}},"scepCertificates":{"description":"Feature Certificates Enrollment through SCEP","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"trustPointName":{"description":"Trust Point Name of SCEP ID Certificate","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"maxLength":32,"type":"string","pattern":"(^([a-zA-Z])([a-zA-Z0-9_-])+)$"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfTrustpointNameOptionDef"},"certificateUUID":{"description":"UUID of Certificate Record in Database","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfCertificateUUIDOptionDef"},"scepUrl":{"description":"SCEP server URL","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","format":"uri"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfScepUrlOptionDef"},"scepPassword":{"description":"Challenge Password/Phrase","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfScepPasswordOptionDef"},"scepVrf":{"description":"VRF","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":32,"$$ref":"#/components/schemas/CommonCommonDefs_vrfDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfVrfOptionsWithDefault"},"subjectName":{"description":"Certificate Subject Name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"pattern":"^[a-zA-Z0-9].*$","type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfSubjectNameOptionDef"},"crlCheck":{"description":"Certificate Revocation List Check","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","enum":["none","crl","crl none"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"string","enum":["none"]}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_oneOfCrlCheckOptionDef"}},"required":["trustPointName","certificateUUID","scepUrl","crlCheck","subjectName"],"additionalProperties":false}}},"anyOf":[{"required":["certificates"]},{"required":["scepCertificates"]}],"additionalProperties":false}},"required":["name","data"],"x-metadata":{"supportedDeviceTypes":["autonomous-all"],"minVManageVersion":"20.16.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingSystemCertificateCommonRequest_SchemaPayload"}}}}},"$$ref":"#/components/schemas/getListSdRoutingSystemCertificatePayload"},"examples":{"get response example":{"value":{"header":{"generatedOn":1702438718825},"data":[{"parcelId":"09fc54fe-ff36-4640-ae57-c9e71a103902","parcelType":"certificate","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1701866357838,"lastUpdatedOn":1701866357838,"payload":{"data":{"scepCertificates":[{"trustPointName":{"optionType":"global","value":"trustpoint_name"},"certificateUUID":{"optionType":"global","value":"28C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51C"},"scepUrl":{"optionType":"global","value":"http://scepserver.com"},"subjectName":{"optionType":"global","value":"featureCert"},"crlCheck":{"optionType":"global","value":"none"}}]}}}]},"$$ref":"#/components/examples/getListSdRoutingSystemCertificateExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e SD-Routing System \u003e Certificate-read","method":"get","path":"/v1/feature-profile/sd-routing/system/{systemId}/certificate"}}