You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Service Key authentication for the Cloudflare API is deprecated and will be removed on September 30, 2026. Migrate to API Tokens."
4
+
products:
5
+
- fundamentals
6
+
date: 2026-03-19
7
+
---
8
+
9
+
Service Key authentication for the Cloudflare API is deprecated. Service Keys will stop working on September 30, 2026.
10
+
11
+
[API Tokens](/fundamentals/api/get-started/create-token/) replace Service Keys with fine-grained permissions, expiration, and revocation.
12
+
13
+
## What you need to do
14
+
15
+
Replace any use of the `X-Auth-User-Service-Key` header with an [API Token](/fundamentals/api/get-started/create-token/) scoped to the permissions your integration requires.
16
+
17
+
If you use `cloudflared`, update to a version from November 2022 or later. These versions already use API Tokens.
18
+
19
+
If you use [origin-ca-issuer](https://github.com/cloudflare/origin-ca-issuer), update to a version that supports API Token authentication.
20
+
21
+
For more information, refer to [API deprecations](/fundamentals/api/reference/deprecations/).
Copy file name to clipboardExpand all lines: src/content/docs/fundamentals/api/get-started/ca-keys.mdx
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,32 +3,33 @@ pcx_content_type: how-to
3
3
title: Get Origin CA keys
4
4
sidebar:
5
5
order: 5
6
-
6
+
badge:
7
+
text: Deprecated
7
8
---
8
9
9
10
import { DashButton } from"~/components";
10
11
11
-
Origin CA keys are often used as the value of header `X-AUTH-USER-SERVICE-KEY` when interacting with [Origin CA certificates](/ssl/origin-configuration/origin-ca/) API. It is also used by [Keyless SSL](/ssl/keyless-ssl/) key server.
12
-
13
-
:::note
14
-
You can also interact with the [Origin CA certificates API](/ssl/origin-configuration/origin-ca/#api-calls) using an [API token](/fundamentals/api/get-started/create-token/) with **Permissions** that include `Zone`-`SSL and Certificates`-`Edit`.
12
+
:::caution[Deprecated]
13
+
Origin CA keys (Service Keys) are deprecated and will be removed on September 30, 2026. Use an [API Token](/fundamentals/api/get-started/create-token/) with `Zone`-`SSL and Certificates`-`Edit` permissions instead. For more information, refer to [API deprecations](/fundamentals/api/reference/deprecations/).
15
14
:::
16
15
16
+
Origin CA keys are often used as the value of header `X-AUTH-USER-SERVICE-KEY` when interacting with [Origin CA certificates](/ssl/origin-configuration/origin-ca/) API. It is also used by [Keyless SSL](/ssl/keyless-ssl/) key server.
17
+
17
18
The key value always starts with `v1.0-`.
18
19
19
20
## Limitations
20
21
21
-
* Changing the Origin CA key is not recorded by [Audit Logs](/fundamentals/account/account-security/review-audit-logs/).
22
-
* Each time you view the Origin CA key, it will be presented as a different value. All these different values are **simultaneously valid** until you click the `Change` button, which immediately invalidates all previously generated values.
23
-
* Origin CA keys have access to every account the user has access to.
22
+
- Changing the Origin CA key is not recorded by [Audit Logs](/fundamentals/account/account-security/review-audit-logs/).
23
+
- Each time you view the Origin CA key, it will be presented as a different value. All these different values are **simultaneously valid** until you click the `Change` button, which immediately invalidates all previously generated values.
24
+
- Origin CA keys have access to every account the user has access to.
24
25
25
26
## View/Change your Origin CA keys
26
27
27
28
To retrieve your Origin CA keys:
28
29
29
30
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com).
30
31
31
-
<DashButtonurl="/?to=/:account/home" />
32
+
<DashButtonurl="/?to=/:account/home" />
32
33
33
34
2. Go to **User Profile** > **API Tokens**.
34
35
3. In the **API Keys** section, select `Origin CA Key`.
If your origin only receives traffic from <GlossaryTooltipterm="proxy status">proxied records</GlossaryTooltip>, use Cloudflare origin CA certificates to encrypt traffic between Cloudflare and your origin web server and reduce bandwidth consumption. Once deployed, these certificates are compatible with [Strict SSL mode](/ssl/origin-configuration/ssl-modes/full-strict/).
14
22
@@ -130,7 +138,7 @@ Wildcards may only cover one level, but can be used multiple times on the same c
130
138
131
139
## API calls
132
140
133
-
To automate processes involving Origin CA certificates, use the following API calls. To authenticate, use either [Origin CA Keys](/fundamentals/api/get-started/ca-keys/) or an [API token](/fundamentals/api/get-started/create-token/) with **Permissions** that include `Zone`-`SSL and Certificates`-`Edit`.
141
+
To automate processes involving Origin CA certificates, use the following API calls. To authenticate, use an [API token](/fundamentals/api/get-started/create-token/) with **Permissions** that include `Zone`-`SSL and Certificates`-`Edit`.
Service Key authentication for the Cloudflare API is deprecated and will be removed on September 30, 2026. [API Tokens](/fundamentals/api/get-started/create-token/) are capable of providing all functionality of Service Keys, with additional support for fine-grained permission scoping, expiration, and IP address restrictions.
14
+
15
+
Deprecated behavior:
16
+
* Authenticating API requests using the `X-Auth-User-Service-Key` header.
17
+
* Generating new Service Keys via the Cloudflare dashboard or API. The ability to generate new Service Keys from the Dashboard will be removed soon.
18
+
19
+
Replacement:
20
+
* [Create an API Token](/fundamentals/api/get-started/create-token/) with the appropriate permissions for your use case. API Tokens support fine-grained scoping, expiration, and revocation.
21
+
22
+
Users of `cloudflared` should ensure they are running a version from November 2022 or later, which uses API Tokens instead of Service Keys. Users of [origin-ca-issuer](https://github.com/cloudflare/origin-ca-issuer) should update to a version that supports API Token authentication.
0 commit comments