1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2020 NOKIA
15 title: CertService Documentation
16 description: Certification service API documentation
19 - url: http://localhost:8080
20 description: Generated server url
23 description: Monitor and interact
25 description: Spring Boot Actuator Web API Documentation
26 url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/
28 /v1/certificate/{caName}:
31 - CertificationService
32 summary: sign certificate
33 description: Web endpoint for requesting certificate signing. Used by system
34 components to gain certificate signed by CA.
35 operationId: signCertificate
39 description: Name of certification authority that will sign CSR.
45 description: Certificate signing request in form of PEM object encoded in
46 Base64 (with header and footer).
52 description: Private key in form of PEM object encoded in Base64 (with header
59 description: certificate successfully signed
61 application/json; charset=utf-8:
63 $ref: '#/components/schemas/CertificationModel'
65 description: something went wrong during connecting to cmp client
67 application/json; charset=utf-8:
69 $ref: '#/components/schemas/ErrorResponseModel'
71 description: CA not found for given name
73 application/json; charset=utf-8:
75 $ref: '#/components/schemas/ErrorResponseModel'
77 description: given CSR or/and PK is incorrect
79 application/json; charset=utf-8:
81 $ref: '#/components/schemas/ErrorResponseModel'
85 - CertificationService
86 summary: check is container is ready
87 description: Web endpoint for checking if service is ready to be used.
88 operationId: checkReady
91 description: configuration is loaded and service is ready to use
93 application/json; charset=utf-8:
97 description: configuration loading failed and service is unavailable
99 application/json; charset=utf-8:
105 - CertificationService
106 summary: reload service configuration from file
107 description: Web endpoint for performing configuration reload. Used to reload
108 configuration file from file.
109 operationId: reloadConfiguration
112 description: configuration has been successfully reloaded
114 application/json; charset=utf-8:
118 description: something went wrong during configuration loading
120 application/json; charset=utf-8:
122 $ref: '#/components/schemas/ErrorResponseModel'
127 summary: Actuator web endpoint 'health'
128 operationId: handle_0
131 description: default response
137 summary: Actuator web endpoint 'health-path'
138 operationId: handle_1
141 description: default response
147 summary: Actuator root web endpoint
151 description: default response