All URIs are relative to http://localhost/ejbca/ejbca-rest-api
| Method | HTTP request | Description |
|---|---|---|
| CreateCrl | Post /v1/ca/{issuer_dn}/createcrl | Create CRL(main, partition and delta) issued by this CA |
| GetCertificateAsPem | Get /v1/ca/{subject_dn}/certificate/download | Get PEM file with the active CA certificate chain |
| GetLatestCrl | Get /v1/ca/{issuer_dn}/getLatestCrl | Returns the latest CRL issued by this CA |
| ImportCrl | Post /v1/ca/{issuer_dn}/importcrl | Import a certificate revocation list (CRL) for a CA |
| ListCas | Get /v1/ca | Returns the Response containing the list of CAs with general information per CA as Json |
| Status1 | Get /v1/ca/status | Get the status of this REST Resource |
CreateCrlRestResponse CreateCrl(ctx, issuerDn).Deltacrl(deltacrl).Execute()
Create CRL(main, partition and delta) issued by this CA
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
issuerDn := "issuerDn_example" // string | the CRL issuers DN (CAs subject DN)
deltacrl := true // bool | true to also create the deltaCRL, false to only create the base CRL (optional) (default to false)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CaApi.CreateCrl(context.Background(), issuerDn).Deltacrl(deltacrl).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CaApi.CreateCrl``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateCrl`: CreateCrlRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CaApi.CreateCrl`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issuerDn | string | the CRL issuers DN (CAs subject DN) |
Other parameters are passed through a pointer to a apiCreateCrlRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
deltacrl | bool | true to also create the deltaCRL, false to only create the base CRL | [default to false]
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCertificateAsPem(ctx, subjectDn).Execute()
Get PEM file with the active CA certificate chain
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
subjectDn := "subjectDn_example" // string | CAs subject DN
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CaApi.GetCertificateAsPem(context.Background(), subjectDn).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CaApi.GetCertificateAsPem``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| subjectDn | string | CAs subject DN |
Other parameters are passed through a pointer to a apiGetCertificateAsPemRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CrlRestResponse GetLatestCrl(ctx, issuerDn).DeltaCrl(deltaCrl).CrlPartitionIndex(crlPartitionIndex).Execute()
Returns the latest CRL issued by this CA
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
issuerDn := "issuerDn_example" // string | the CRL issuers DN (CAs subject DN)
deltaCrl := true // bool | true to get the latest deltaCRL, false to get the latest complete CRL (optional) (default to false)
crlPartitionIndex := int32(56) // int32 | the CRL partition index (optional) (default to 0)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CaApi.GetLatestCrl(context.Background(), issuerDn).DeltaCrl(deltaCrl).CrlPartitionIndex(crlPartitionIndex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CaApi.GetLatestCrl``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetLatestCrl`: CrlRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CaApi.GetLatestCrl`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issuerDn | string | the CRL issuers DN (CAs subject DN) |
Other parameters are passed through a pointer to a apiGetLatestCrlRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
deltaCrl | bool | true to get the latest deltaCRL, false to get the latest complete CRL | [default to false] crlPartitionIndex | int32 | the CRL partition index | [default to 0]
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ImportCrl(ctx, issuerDn).CrlFile(crlFile).CrlPartitionIndex(crlPartitionIndex).Execute()
Import a certificate revocation list (CRL) for a CA
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
issuerDn := "issuerDn_example" // string | the CRL issuers DN (CAs subject DN)
crlFile := os.NewFile(1234, "some_file") // *os.File | CRL file in DER format (optional)
crlPartitionIndex := int32(56) // int32 | CRL partition index (optional) (default to 0)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CaApi.ImportCrl(context.Background(), issuerDn).CrlFile(crlFile).CrlPartitionIndex(crlPartitionIndex).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CaApi.ImportCrl``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| issuerDn | string | the CRL issuers DN (CAs subject DN) |
Other parameters are passed through a pointer to a apiImportCrlRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
crlFile | *os.File | CRL file in DER format | crlPartitionIndex | int32 | CRL partition index | [default to 0]
(empty response body)
No authorization required
- Content-Type: multipart/form-data
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CaInfosRestResponse ListCas(ctx).Execute()
Returns the Response containing the list of CAs with general information per CA as Json
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CaApi.ListCas(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CaApi.ListCas``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListCas`: CaInfosRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CaApi.ListCas`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiListCasRequest struct via the builder pattern
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RestResourceStatusRestResponse Status1(ctx).Execute()
Get the status of this REST Resource
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.V1CaApi.Status1(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `V1CaApi.Status1``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `Status1`: RestResourceStatusRestResponse
fmt.Fprintf(os.Stdout, "Response from `V1CaApi.Status1`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiStatus1Request struct via the builder pattern
RestResourceStatusRestResponse
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]