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
Copy file name to clipboardExpand all lines: src/docs/guides/cli.md
+20-26Lines changed: 20 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,23 +96,23 @@ In situations where user input or interaction isn't possible, such as in CI/CD p
96
96
97
97
A [Project Token](/guides/public-api#project-token) is set via the `RAILWAY_TOKEN` environment variable.
98
98
99
-
An [Account](/guides/public-api#using-an-account-token) or [Workspace](/guides/public-api#using-a-workspace-token) Token is set via the `RAILWAY_API_TOKEN` environment variable.
99
+
An [Account](/guides/public-api#personal-token) or [Team](/guides/public-api#team-token) Token is set via the `RAILWAY_API_TOKEN` environment variable.
100
100
101
-
**Note:**If both environment variables are set, `RAILWAY_TOKEN` takes precedence. This allows you to use a project token for specific deployments while having a broader account token configured.
101
+
**Note:**You can only use one type of token at a time. If both are set, the `RAILWAY_TOKEN` variable will take precedence.
102
102
103
103
#### Project Tokens
104
104
105
-
You can use [Project Tokens](/guides/public-api#project-token) to authenticate project-level actions within a single environment.
105
+
You can use [Project Tokens](/guides/public-api#project-token) to authenticate project-level actions.
106
106
107
-
Project tokens are scoped to a specific environment within a project. If you need to perform actions across multiple environments, use an account or workspace token instead.
107
+
Project Tokens allow the CLI to access all the project-level actions in the environment set when the token was created.
108
108
109
-
Some actions you can perform with a project token include:
109
+
Some actions you can perform with a project token include -
110
110
111
111
- Deploying code - `railway up`
112
112
- Redeploying a deployment - `railway redeploy`
113
113
- Viewing build and deployment logs - `railway logs`
114
114
115
-
Some actions you **cannot** perform with a project token include:
115
+
Some actions you **cannot** perform with a project token include -
116
116
117
117
- Creating a new project - `railway init`
118
118
- Printing information about the user - `railway whoami`
@@ -126,32 +126,26 @@ RAILWAY_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX railway up
126
126
127
127
#### Account Tokens
128
128
129
-
You can use [Account Tokens](/guides/public-api#using-an-account-token)to authenticate all CLI actions across all your resources and workspaces. This is the broadest scope—all CLI commands are available with an account token.
129
+
Account Tokens come in two types - [Personal Account Tokens](/reference/public-api#personal-token) and [Team Tokens](/reference/public-api#team-token).
130
130
131
-
Some actions you can **only** perform with an account token include:
131
+
You can use Account Tokens to authenticate all CLI actions across all workspaces.
132
132
133
-
- Printing information about the user - `railway whoami`
134
-
- Linking to projects in any of your workspaces - `railway link`
135
-
136
-
Use the token by setting the `RAILWAY_API_TOKEN` environment variable and then running `railway <command>`.
133
+
However, you can only use Team tokens to authenticate actions on projects within the workspace the token was scoped to when it was created.
Some actions you can perform with a personal account token include -
141
136
142
-
#### Workspace Tokens
143
-
144
-
You can use [Workspace Tokens](/guides/public-api#using-a-workspace-token) to authenticate CLI actions on projects within a specific workspace. Use this when you want to share a token with teammates without giving access to your other workspaces.
137
+
- Creating a new project - `railway init`
138
+
- Printing information about the user - `railway whoami`
145
139
146
-
Some actions you **cannot** perform with a workspace token include:
140
+
Some actions you **cannot** perform with [Team Token](/reference/public-api#team-token) include -
147
141
148
142
- Printing information about the user - `railway whoami`
149
-
- Linking to projects outside the token's workspace - `railway link` (you can still link to other projects within the workspace)
143
+
- Linking to another workspace - `railway link`
150
144
151
145
Use the token by setting the `RAILWAY_API_TOKEN` environment variable and then running `railway <command>`.
152
146
153
147
```bash
154
-
RAILWAY_API_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX railway up
Copy file name to clipboardExpand all lines: src/docs/guides/create.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Note that your template will not be available on the template marketplace, nor w
35
35
36
36
It's now possible to specify a private GitHub repo when creating a template.
37
37
38
-
This feature is intended for use among [Teams](/reference/workspaces) and [Organizations](/reference/workspaces). Users supporting a subscriber base may also find this feature helpful to distribute closed-source code.
38
+
This feature is intended for use among [Teams](/reference/teams) and [Organizations](/reference/teams). Users supporting a subscriber base may also find this feature helpful to distribute closed-source code.
39
39
40
40
To deploy a template that includes a private repo, look for the `GitHub` panel in the `Account Integrations` section of [General Settings](https://railway.com/account). Then select the `Edit Scope` option to grant Railway access to the desired private repos.
If you want to set a usage limit for a different workspace that you are an admin of, use the account switcher in the top left corner of your dashboard to access that workspace's usage page.
18
+
If you want to set a usage limit for your team, use the account switcher in the top left corner of your dashboard to access the team's usage page.
Copy file name to clipboardExpand all lines: src/docs/guides/projects.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,11 +49,11 @@ Each project generates a project invite link. To invite someone via a link:
49
49
50
50
## Transferring Projects
51
51
52
-
Projects can be transferred between workspaces or to other users. Both the source and destination must have an active [Hobby or Pro plan](/reference/pricing#plans) subscription.
52
+
Depending on your plan, you can transfer Projects to other usersor Teams.
53
53
54
-
#### Transferring to Another User
54
+
#### Hobby User to Hobby User
55
55
56
-
To transfer a project to another user, you must first [add the user as a member](#inviting-members)of the project.
56
+
To transfer a project from one Hobby User to another Hobby User, you must first [add the user as a member](#inviting-members)in the project.
57
57
58
58
You can then transfer the project to the new member by selecting the three dots next to the user and choosing `Transfer Ownership`.
59
59
@@ -62,15 +62,15 @@ alt="Screenshot of Project Transfer Menu"
62
62
layout="intrinsic"
63
63
width={411} height={253} quality={80} />
64
64
65
-
The recipient receives an email to confirm the transfer. They have 24 hours to accept.
65
+
The transferee receives an email requesting to transfer the project.
66
66
67
-
#### Transferring Between Workspaces
67
+
#### Hobby User to Team || Team to Team
68
68
69
-
You can transfer a project to another workspace that you're a member of. Inside your project, visit the `Settings` page and click the `Transfer Project` button to view the project transfer modal.
69
+
You can transfer a Project in your Hobby workspace to a Team (or between Teams) in which you are an Admin. Inside your project, visit the `Settings` page and click the `Transfer Project` button to view the project transfer modal.
Note: You must be an Admin of the project to initiate a transfer. The destination workspace must have an active Hobby or Pro subscription. See the [Workspaces reference](/reference/workspaces#inviting-members) for more information on workspace roles.
73
+
Note: If you do not see the Transfer Project section in your Project Settings, you may not be an Admin of the Team to which you wish to transfer the Project. See the [reference page for Teams](/reference/teams#inviting-members) for more information on team member permissions.
To use the API, you will need an API token. There are three types of tokens you can create in the Railway dashboard. If you're building an application that authenticates users, you can also use OAuth.
33
+
To use the API, you will need an API token. There are three types of tokens you can create.
34
34
35
-
#### Choosing a Token Type
35
+
#### Team Tokens and Account Tokens
36
36
37
-
| Token Type | Scope | Best For |
38
-
|------------|-------|----------|
39
-
| Account token | All your resources and workspaces | Personal scripts, local development |
40
-
| Workspace token | Single workspace | Team CI/CD, shared automation |
41
-
| Project token | Single environment in a project | Deployments, service-specific automation |
42
-
| OAuth | User-granted permissions | Third-party apps acting on behalf of users |
37
+
You can create an API token from the [tokens page](https://railway.com/account/tokens) in your account settings.
43
38
44
-
#### Account Tokens and Workspace Tokens
45
-
46
-
You can create a workspace or account token from the [tokens page](https://railway.com/account/tokens) in your account settings.
-**Account token**: If you select "No workspace", the token will be tied to your Railway account. This is the broadest scope. The token can perform any API action you're authorized to do across all your resources and workspaces. Do not share this token with anyone else.
54
-
-**Workspace token**: Select a specific workspace in the dropdown to create a token scoped to that workspace. A workspace token has access to all the workspace's resources, and cannot be used to access your personal resources or other workspaces on Railway. You can share this token with your teammates.
44
+
-**Team token** - Select a team in the `Team` dropdown to create a token tied to a team. A team token has access to all the team's resources, and cannot be used to access your personal resources on Railway. Feel free to share this token with your teammates.
45
+
-**Account token** - If you do not select a team, the token will be tied to your Railway account and will have access to all your resources including the teams you are a part of. Do not share this token with anyone else.
46
+
47
+
_Note that Teams are a Pro feature._
55
48
56
49
#### Project Token
57
50
@@ -79,21 +72,21 @@ curl --request POST \
79
72
--data '{"query":"query { me { name email } }"}'
80
73
```
81
74
82
-
**Note:** This query **cannot** be used with a workspace or project token because the data returned is scoped to your personal account.
75
+
**Note:** This query **cannot** be used with a team or project token because the data returned is scoped to your personal account.
83
76
84
-
#### Using a Workspace Token
77
+
#### Using a Team Token
85
78
86
-
If you have a workspace token, you can use it to authenticate requests scoped to that workspace. The query below should return the workspace name and ID:
79
+
If you have a team token, you can use it to authenticate requests to a specific team. The query below should return the team name and ID:
**Note:** Project tokens use the `Project-Access-Token` header, not the `Authorization: Bearer` header used by account, workspace, and OAuth tokens.
111
-
112
103
## Viewing the Schema
113
104
114
105
Use popular tools like [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/) to connect to the API and query the schema. Simply set up your connection with the endpoint and Authorization token, and fetch the schema.
@@ -125,18 +116,12 @@ Alternatively, you can use our [GraphiQL playground](https://railway.com/graphiq
Make sure to set a header with your [authorization token](/reference/public-api#authentication). Click the "Headers" tab at the bottom of the GraphiQL page and enter this json, using your own token based on your use case:
119
+
Make sure to set an Authorization header with an [auth token](/reference/public-api#authentication). Click the "Headers" tab at the bottom of the GraphiQL page and enter this json, using your own token:
Copy file name to clipboardExpand all lines: src/docs/guides/templates-best-practices.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -119,7 +119,7 @@ A clean, minimal repository helps users quickly understand the template's struct
119
119
120
120
## Workspace Naming
121
121
122
-
When users deploy a template, the template author appears as the name of the <ahref="/reference/workspaces"target="_blank">workspace</a> that created and published it.
122
+
When users deploy a template, the template author appears as the name of the <ahref="/reference/teams"target="_blank">workspace</a> that created and published it.
123
123
124
124
Since the author is publicly visible and shown with the template to the users, it is important to make sure the workspace name is professional and **accurately represents your relationship to the software**.
Copy file name to clipboardExpand all lines: src/docs/reference/audit-logs.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Audit Logs
3
3
description: Learn more about how Railway keeps a record of actions in workspaces.
4
4
---
5
5
6
-
Audit logs provide a record of actions performed within your Railway [workspace](/reference/workspaces). This includes changes to projects, services, deployments, variables, and workspace settings.
6
+
Audit logs provide a record of actions performed within your Railway [workspace](/reference/teams). This includes changes to projects, services, deployments, variables, and workspace settings.
7
7
8
8
Audit logs can be accessed by workspace admins through the <ahref="https://railway.com/workspace/audit-logs"target="_blank">**Audit Logs**</a> link in the workspace settings.
9
9
@@ -28,7 +28,7 @@ To view audit logs:
28
28
1. Navigate to your workspace dashboard
29
29
2. Click on <ahref="https://railway.com/workspace/audit-logs"target="_blank">**Audit Logs**</a> in the sidebar
30
30
31
-
For more information about workspace roles and permissions, see the [Workspaces documentation](/reference/workspaces).
31
+
For more information about workspace roles and permissions, see the [Workspaces documentation](/reference/teams).
0 commit comments