Skip to content

[ EDU-6735] fix: updated work with domains guides with v4 #1812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 21, 2025
Merged

[ EDU-6735] fix: updated work with domains guides with v4 #1812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0f8620
fix: updated work with domains guides with v4
LuizaVSantos Aug 20, 2025
cbc49fc
Apply suggestions from code review
LuizaVSantos Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/content/docs/en/pages/main-menu/work-with-domains/configure-domains.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ In this guide, there are separate instructions for API v3 and API v4. If you're
## Configuring a domain with Azion

<Tabs client:visible>
<Fragment slot="tab.consoleworkloads">Console - Workloads</Fragment>
<Fragment slot="tab.consoledomain">Console - Domains</Fragment>
<Fragment slot="tab.apiv4">API v4</Fragment>
<Fragment slot="tab.apiv3">API v3</Fragment>
<Fragment slot="tab.consoleworkloads">Console - Workloads</Fragment>
<Fragment slot="tab.consoledomain">Console - Domains</Fragment>
<Fragment slot="tab.apiv4">API v4</Fragment>
<Fragment slot="tab.apiv3">API v3</Fragment>

<Fragment slot="panel.consoleworkloads">

Expand All @@ -48,6 +48,7 @@ To create a Workload:
9. Click the **Save** button.

Wait a few minutes for your new Workload to propagate and access your `xxxxxxxxxx.map.azionedge.net` address to see your Edge Application online.

</Fragment>

<Fragment slot="panel.consoledomain">
Expand Down
165 changes: 134 additions & 31 deletions src/content/docs/en/pages/main-menu/work-with-domains/create-certificate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ permalink: /documentation/products/guides/create-a-digital-certificate/
import Tabs from '~/components/tabs/Tabs'
import Code from '~/components/Code/Code.astro'

import Apiv4Rollout from '~/includes/snippets/apiv4Rollout/en/snippet.mdx'

<Apiv4Rollout />

If your application runs on HTTPS, you'll need to register a certificate with Azion [Digital Certificates](/en/documentation/products/secure/edge-firewall/digital-certificates/). A TLS digital certificate confirms a website's identity and protects data transfers. It secures financial transactions and any exchange of sensitive information, from login credentials to personal data.

You can also request that a **Let's Encrypt certificate** be generated for your domain through Azion. The process for requesting a Let's Encrypt certificate is different from custom certificates. See [how to generate a Let's Encrypt certificate](/en/documentation/products/guides/how-to-generate-a-lets-encrypt-certificate/) for more information.
Expand All @@ -20,6 +24,12 @@ You can also request that a **Let's Encrypt certificate** be generated for your
- Don't have a digital certificate? Check the guide on [How to acquire and register a Digital Certificate with Azion](/en/documentation/products/guides/secure/digital-certificates/).
:::

There are separate instructions for the [legacy Domains](/en/documentation/products/build/edge-application/domains/) settings and the new [Workloads](/en/documentation/products/secure/workloads) product.

:::tip
In this guide, there are separate instructions for API v3 and API v4. If you're not sure which steps apply to your account, see [the Verify Your Account Migration guide](/en/documentation/products/guides/verify-account-migration/) to determine if your account has already been migrated.
:::

---

## Option 1: Upload custom certificate
Expand All @@ -45,14 +55,17 @@ You can also request that a **Let's Encrypt certificate** be generated for your
4. Run the following cURL command in your terminal, replacing `[TOKEN VALUE]` with your [personal token](/en/documentation/products/guides/personal-tokens/) and adding your certificate and private key to the fields:

<Code lang="bash" code={`
curl --location 'https://api.azionapi.net/digital_certificates' \
--header 'Accept: application/json; version=3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--data '{
"name": "CERT yourdomain.com",
"certificate": "-----BEGIN CERTIFICATE-----\n<your_private_key>\n-----END CERTIFICATE-----",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n<your_private_key>\n-----END RSA PRIVATE KEY-----"
curl --request POST \
--url https://api.azion.com/v4/digital_certificates/certificates \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "CERT yourdomain.com",
"certificate": "-----BEGIN CERTIFICATE-----\n<your_private_key>\n-----END CERTIFICATE-----",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n<your_private_key>\n-----END RSA PRIVATE KEY-----",
"type": "edge_certificate",
"active": true
}'
`} />

Expand All @@ -64,7 +77,7 @@ curl --location 'https://api.azionapi.net/digital_certificates' \

Upon uploading your custom certificate, you'll receive a successful response:

```json
<Code lang="json" code={`
{
"results": {
"id": <digital_certificate_id>,
Expand All @@ -77,7 +90,7 @@ Upon uploading your custom certificate, you'll receive a successful response:
"managed": false
}
}
```
`} />
</Fragment>

</Tabs>
Expand All @@ -91,6 +104,7 @@ Upon uploading your custom certificate, you'll receive a successful response:
<Fragment slot="tab.api">API</Fragment>

<Fragment slot="panel.console">

1. Access [Azion Console](/en/documentation/products/guides/how-to-access-azion-console/) > **Digital Certificates**.
2. Click the **+ Digital Certificate** button.
3. Name your certificate.
Expand All @@ -100,19 +114,22 @@ Upon uploading your custom certificate, you'll receive a successful response:
</Fragment>

<Fragment slot="panel.api">

1. Acquire a trusted certificate signed by your CA.
2. Replace any line breaks with `\n`, including for the begin and end markers, to turn the certificate into a string.
3. Run the following cURL command in your terminal, replacing `[TOKEN VALUE]` with your [personal token](/en/documentation/products/guides/personal-tokens/) and adding your certificate and to the fields:

<Code lang="bash" code={`
curl --location 'https://api.azionapi.net/digital_certificates' \
--header 'Accept: application/json; version=3' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "TCA yourdomain.com",
"certificate": "-----BEGIN CERTIFICATE-----\n<your_trusted_ca_certificate>\n-----END CERTIFICATE-----",
"certificate_type": "trusted_ca_certificate"
curl --request POST \
--url https://api.azion.com/v4/digital_certificates/certificates \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"name": "TCA yourdomain.com",
"certificate": "-----BEGIN CERTIFICATE-----\n<your_private_key>\n-----END CERTIFICATE-----",
"type": "trusted_ca_certificate",
"active": true
}'
`} />

Expand All @@ -124,7 +141,7 @@ curl --location 'https://api.azionapi.net/digital_certificates' \

Upon uploading your Trusted CA, you'll receive a successful response:

```json
<Code lang="json" code={`
{
"results": {
"id": <digital_certificate_id>,
Expand All @@ -137,7 +154,7 @@ Upon uploading your Trusted CA, you'll receive a successful response:
"managed": false
}
}
```
`} />
</Fragment>

</Tabs>
Expand All @@ -149,10 +166,29 @@ Upon uploading your Trusted CA, you'll receive a successful response:
Now you need to associate your certificate to an Azion domain:

<Tabs client:visible>
<Fragment slot="tab.console">Console</Fragment>
<Fragment slot="tab.api">API</Fragment>
<Fragment slot="tab.consoleworkloads">Console - Workloads</Fragment>
<Fragment slot="tab.consoledomain">Console - Domains</Fragment>
<Fragment slot="tab.apiv4">API v4</Fragment>
<Fragment slot="tab.apiv3">API v3</Fragment>

<Fragment slot="panel.consoleworkloads">

1. On the upper-left corner of the page, open the **Products menu**, represented by three horizontal lines > **Workloads**.
2. Select the desired Workload.
3. In **Digital Certificate**, select the certificate you created in the previous steps.
4. Make sure the domain listed in the **Subdomain** and **Domain** fields are the same as the issued certificate for your domain.
5. Click the **Save** button.
6. Wait a couple of minutes for the changes to propagate.

You can access your HTTPS application and check the security settings using your browser or run the following OpenSSL command, replacing `yourdomain.com` with one of the CNAMEs of the domain:

<Code lang="bash" code={`
openssl s_client -showcerts -connect yourdomain.com:443
`} />
</Fragment>

<Fragment slot="panel.consoledomain">

<Fragment slot="panel.console">
1. On the upper-left corner of the page, open the **Products menu**, represented by three horizontal lines > **Domains**.
2. Select the desired domain.
3. In **Digital Certificate**, select the certificate you created in the previous steps.
Expand All @@ -167,7 +203,74 @@ openssl s_client -showcerts -connect yourdomain.com:443
`} />
</Fragment>

<Fragment slot="panel.api">
<Fragment slot="panel.v4">

1. Run the following `GET` request to retrieve your Workload's id:

<Code lang="bash" code={`
curl --request GET \
--url https://api.azion.com/v4/workspace/workloads \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]'
`} />

2. You'll receive a response similar to this:

<Code lang="json" code={`
"results": [
{
"id": <workload_id>,
"name": "My Workload",
"active": true,
"last_editor": "[email protected]",
"last_modified": "2025-08-06T17:53:47.460211Z",
"infrastructure": 1,
"tls": {
"certificate": null,
"ciphers": 7,
"minimum_version": "tls_1_3"
},
}
]
`} />

3. Locate the domain you wish to associate to the certificate and copy the `workload_id` value received in the response.
4. Run a `PATCH` request, adding the `workload_id` as a path, to update the `digital_certificate_id` field with the id you received in the creation process:

:::note[Optional]
As shown in the example below, if you didn't update the Domain and Subdomain fields with your custom domain yet, make sure to add the host and any common names for the application that are protected by the certificate. This will be useful when you later [point your domain](/en/documentation/products/guides/point-domain-to-azion/) or [migrate your NS resolution](/en/documentation/products/guides/migrate-ns-to-azion/) to Azion.
:::

<Code lang="bash" code={`
curl --request PATCH \
--url https://api.azion.com/v4/workspace/workloads/{workload_id} \
--header 'Accept: application/json' \
--header 'Authorization: Token [TOKEN VALUE]' \
--header 'Content-Type: application/json' \
--data '{
"tls": {
"certificate": <digital_certificate_id>
},
"domains": [
"yourdomain.com"
]
}'
`} />

5. You should receive a response with the updated data.
6. Wait a couple of minutes for the changes to propagate. Then, access your HTTPS application and check the security settings using your browser or run the following OpenSSL command, replacing `yourdomain.com` with one of the CNAMEs of the domain:

<Code lang="bash" code={`
openssl s_client -showcerts -connect yourdomain.com:443
`} />

:::tip
Check the [Azion API documentation](https://api.azion.com/v3) to know more about all features available via API.
:::
</Fragment>

<Fragment slot="panel.apiv3">

1. Run the following `GET` request to retrieve your domain's id:

<Code lang="bash" code={`
Expand All @@ -178,7 +281,7 @@ curl --location 'https://api.azionapi.net/domains' \

2. You'll receive a response similar to this:

```json
<Code lang="json" code={`
{
...
"results": [
Expand All @@ -194,7 +297,7 @@ curl --location 'https://api.azionapi.net/domains' \
}
]
}
```
`} />

3. Locate the domain you wish to associate to the certificate and copy the `domain_id` value received in the response.
4. Run a `PATCH` request, adding the `domain_id` as a path, to update the `digital_certificate_id` field with the id you received in the creation process:
Expand All @@ -203,7 +306,7 @@ curl --location 'https://api.azionapi.net/domains' \
As shown in the example below, if you didn't update the CNAME field with your custom domain yet, make sure to add the host and any common names for the application that are protected by the certificate. This will be useful when you later [point your domain](/en/documentation/products/guides/point-domain-to-azion/) or [migrate your NS resolution](/en/documentation/products/guides/migrate-ns-to-azion/) to Azion.
:::

```bash
<Code lang="bash" code={`
curl --location --request PATCH 'https://api.azionapi.net/domains/<domain_id>' \
--header 'Accept: application/json; version=3' \
--header 'Authorization: Token [TOKEN VALUE]' \
Expand All @@ -214,17 +317,17 @@ curl --location --request PATCH 'https://api.azionapi.net/domains/<domain_id>' \
"yourdomain.com"
]
}'
```
`} />

5. You should receive a response with the updated data.
6. Wait a couple of minutes for the changes to propagate. Then, access your HTTPS application and check the security settings using your browser or run the following OpenSSL command, replacing `yourdomain.com` with one of the CNAMEs of the domain:

```bash
<Code lang="bash" code={`
openssl s_client -showcerts -connect yourdomain.com:443
```
`} />

:::tip
Check the [Azion API documentation](https://api.azion.com/) and the [OpenAPI specification](https://github.com/aziontech/azionapi-openapi/) to know more about all features available via API.
Check the [Azion API documentation](https://api.azion.com/v3) to know more about all features available via API.
:::
</Fragment>

Expand Down
Loading