Skip to content

Commit

Permalink
Merge pull request #440 from laserchicken/mk/feat-update-readme-cert-…
Browse files Browse the repository at this point in the history
…generate

other: update x509 TLS certificate generation README
  • Loading branch information
olexandr-mazepa authored Mar 4, 2025
2 parents c233014 + 77b8615 commit c20078d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1747,14 +1747,14 @@ The following service methods are available to instantiated clients. The example
```
- #### generate
Initiates generation of a TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll the status endpoint in location field to check for success
Initiates generation of a TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll the status endpoint in location field to check for success. Domain address must be formatted as `webPrefix.domainName` from domains settings
`mg.domains.domainTracking.generate(domainAddress)` [api docs](https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Domain-Tracking/#tag/Domain-Tracking/operation/httpapi.(*HttpAPI).generateStatusV2-fm-8)
Example:
```JS
mg.domains.domainTracking.generate('foobar.example.com')
mg.domains.domainTracking.generate('email.foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Expand All @@ -1770,14 +1770,14 @@ The following service methods are available to instantiated clients. The example
```
- #### regenerate
Initiates regeneration of an expired TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll status endpoint in location field to check for success. This will not regenerate an existing certificate that is still valid
Initiates regeneration of an expired TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll status endpoint in location field to check for success. This will not regenerate an existing certificate that is still valid. Domain address must be formatted as `webPrefix.domainName` from domains settings
`mg.domains.domainTracking.regenerate(domainAddress)` [api docs](https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Domain-Tracking/#tag/Domain-Tracking/operation/httpapi.(*HttpAPI).generateStatusV2-fm-8)
Example:
```JS
mg.domains.domainTracking.regenerate('foobar.example.com')
mg.domains.domainTracking.regenerate('email.foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Expand Down

0 comments on commit c20078d

Please sign in to comment.