Document ZenML Pro Personal Access Tokens and deprecate API tokens #4133

stefannica · 2025-11-05T10:07:07Z

Describe changes

Document ZenML Pro Personal Access Tokens and deprecate API tokens.

This PR also removes the recently introduced zenml token CLI command.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

github-actions · 2025-11-05T10:31:32Z

✅ No broken links found!

htahir1

One comment for now. Also can you give me the final URL that i can use in the dashboard? i need something to link from the zenml cloud dashboard to the docs page that described the PAT

htahir1 · 2025-11-05T10:46:23Z

docs/book/getting-started/zenml-pro/personal-access-tokens.md

I am wondering, whether it makes sense to add a page here in the main Documentation space and call it "with a PAT" and thne write there that this is a pro feature and add a link to this page:

github-actions · 2025-11-05T10:59:20Z

Documentation Link Check Results

❌ Absolute links check failed
There are broken absolute links in the documentation. See workflow logs for details
✅ Relative links check passed
_{Last checked: 2025-11-07 13:37:48 UTC}

htahir1

Requested some changes and left you some screenshots you can use

docs/book/how-to/manage-zenml-server/connecting-to-zenml/README.md

docs/book/getting-started/zenml-pro/personal-access-tokens.md

htahir1 · 2025-11-05T12:51:41Z

Ah one more thing. Now that we have service accounts and personal access tokens might make sense to add a new section called "Access Management" in here (Same as Core Concepts, Deployments)

com/user-attachments/assets/f5b0bb08-5f07-44ab-9cab-6cd62c04ed48" />

github-actions · 2025-11-06T21:05:57Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 25.5%, saving 44.79 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/pro-personal-access-tokens-01.png`	175.50 KB	130.71 KB	-25.5%	View diff

380 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

stefannica · 2025-11-06T21:10:45Z

@htahir1 I applied all your suggestions, please take a look here: https://zenml-io.gitbook.io/stefan/

htahir1

This looks way better now - Just two things:

a) I think you are inferring the URLs wrongly. Best way is to map them to your preview so https://zenml-io.gitbook.io/stefan/zenml-pro/access-management/personal-access-tokens will be https://docs.zenml.io/pro/access-management/personal-access-tokens (Note that in your space its /zenml-pro/ but in the real space it will be /pro/)

b) You have not added redirects as I asked in the .gitbook.yaml ;-) Reminder :-)

htahir1 · 2025-11-07T09:52:47Z

docs/book/how-to/manage-zenml-server/connecting-to-zenml/connect-with-a-pat.md

+
+# Connect with a Personal Access Token
+
+If you are using ZenML Pro and need to call the ZenML Pro workspace API from a non-interactive environment, you also have the option of creating and using a Personal Access Token. Personal Access Tokens are scoped to your ZenML Pro user account and can be used to access all workspaces you are a member of in any organization. See the [ZenML Pro Personal Access Tokens](https://docs.zenml.io/pro/core-concepts/personal-access-tokens) documentation for more information.


Is this going to be the URL? https://docs.zenml.io/pro/core-concepts/personal-access-tokens, in your preview I see https://zenml-io.gitbook.io/stefan/zenml-pro/access-management/personal-access-tokens

htahir1 · 2025-11-07T09:53:03Z

...ook/how-to/infrastructure-deployment/stack-deployment/deploy-a-cloud-stack-with-terraform.md

 ```

-If you're using a ZenML Pro server, you will need to create an organization-level service account and an API key for it. You can find more about organization-level service accounts and API keys [here](https://docs.zenml.io/pro/core-concepts/service-accounts).
+If you're using a ZenML Pro server, you will need to create a Personal Access Token or an organization-level service account and an API key for it. You can find more about Personal Access Tokens [here](https://docs.zenml.io/pro/core-concepts/personal-access-tokens) and organization-level service accounts and API keys [here](https://docs.zenml.io/pro/core-concepts/service-accounts).


check URL https://zenml-io.gitbook.io/stefan/zenml-pro/access-management/personal-access-tokens

htahir1 · 2025-11-07T09:53:14Z

docs/book/how-to/infrastructure-deployment/infrastructure-as-code/README.md



-If you're using a ZenML Pro server, you will need to create an organization-level service account and an API key for it. You can find more about organization-level service accounts and API keys [here](https://docs.zenml.io/pro/core-concepts/service-accounts).
+If you're using a ZenML Pro server, you will need to create a Personal Access Token or an organization-level service account and an API key for it. You can find more about Personal Access Tokens [here](https://docs.zenml.io/pro/core-concepts/personal-access-tokens) and organization-level service accounts and API keys [here](https://docs.zenml.io/pro/core-concepts/service-accounts).


URL is not right IMO https://zenml-io.gitbook.io/stefan/zenml-pro/access-management/personal-access-tokens

…nml into feature/deprecate-api-tokens

github-actions · 2025-11-07T13:33:09Z

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feature/deprecate-api-tokens)

zenml stack list: Command failed on run 1 (exit code: 1)
zenml pipeline list: Command failed on run 1 (exit code: 1)
zenml model list: Command failed on run 1 (exit code: 1)

🚨 New Failures Introduced

The following commands fail on your branch but worked on the target branch:

zenml stack list
zenml pipeline list
zenml model list

Performance Comparison

Command	develop Time (s)	feature/deprecate-api-tokens Time (s)	Difference	Status
`zenml --help`	1.477796 ± 0.008124	1.464350 ± 0.017464	-0.013s	✓ No significant change
`zenml model list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml pipeline list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml stack --help`	1.467600 ± 0.023152	1.468313 ± 0.025495	±0.000s	✓ No significant change
`zenml stack list`	Not tested	Failed	N/A	❌ Broken in current branch

Summary

Total commands analyzed: 5
Commands compared for timing: 2
Commands improved: 0 (0.0% of compared)
Commands degraded: 0 (0.0% of compared)
Commands unchanged: 2 (100.0% of compared)
Failed commands: 3 (NEW FAILURES INTRODUCED)
Timed out commands: 0
Slow commands: 0

Environment Info

Target branch: Linux 6.11.0-1018-azure
Current branch: Linux 6.11.0-1018-azure
Test timestamp: 2025-11-07T13:32:22Z
Timeout: 60 seconds
Slow threshold: 5 seconds

Deprecate API tokens

3152cfe

stefannica requested a review from htahir1 November 5, 2025 10:07

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Nov 5, 2025

htahir1 requested changes Nov 5, 2025

View reviewed changes

stefannica added 4 commits November 5, 2025 20:40

Update docs

658b588

Doc updates

85bc951

More doc updates

e69bcb7

Add more docs and allow Pro key to be used to login as OSS key

c940581

stefannica requested a review from htahir1 November 6, 2025 21:03

Optimised images with calibre/image-actions

9324e41

htahir1 requested changes Nov 7, 2025

View reviewed changes

stefannica added 3 commits November 7, 2025 11:50

Update docs

2336113

Add redirect

8454990

Merge branch 'feature/deprecate-api-tokens' of github.com:zenml-io/ze…

ff77e60

…nml into feature/deprecate-api-tokens

stefannica added the run-slow-ci label Nov 7, 2025


		# Connect with a Personal Access Token

		If you are using ZenML Pro and need to call the ZenML Pro workspace API from a non-interactive environment, you also have the option of creating and using a Personal Access Token. Personal Access Tokens are scoped to your ZenML Pro user account and can be used to access all workspaces you are a member of in any organization. See the [ZenML Pro Personal Access Tokens](https://docs.zenml.io/pro/core-concepts/personal-access-tokens) documentation for more information.



		If you're using a ZenML Pro server, you will need to create an organization-level service account and an API key for it. You can find more about organization-level service accounts and API keys [here](https://docs.zenml.io/pro/core-concepts/service-accounts).
		If you're using a ZenML Pro server, you will need to create a Personal Access Token or an organization-level service account and an API key for it. You can find more about Personal Access Tokens [here](https://docs.zenml.io/pro/core-concepts/personal-access-tokens) and organization-level service accounts and API keys [here](https://docs.zenml.io/pro/core-concepts/service-accounts).

Document ZenML Pro Personal Access Tokens and deprecate API tokens #4133

Are you sure you want to change the base?

Document ZenML Pro Personal Access Tokens and deprecate API tokens #4133

Conversation

stefannica commented Nov 5, 2025

Describe changes

Pre-requisites

Types of changes

Uh oh!

github-actions bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

htahir1 left a comment

Choose a reason for hiding this comment

Uh oh!

htahir1 Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

htahir1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

htahir1 commented Nov 5, 2025

Uh oh!

github-actions bot commented Nov 6, 2025

Uh oh!

stefannica commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

htahir1 left a comment

Choose a reason for hiding this comment

Uh oh!

htahir1 Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

htahir1 Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

htahir1 Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 7, 2025

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feature/deprecate-api-tokens)

🚨 New Failures Introduced

Performance Comparison

Summary

Environment Info

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Nov 5, 2025 •

edited

Loading

github-actions bot commented Nov 5, 2025 •

edited

Loading

htahir1 left a comment •

edited

Loading

stefannica commented Nov 6, 2025 •

edited

Loading