- 
                Notifications
    
You must be signed in to change notification settings  - Fork 1.4k
 
Create a page to explain how to find ids #9634
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.
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
                    Changes from 8 commits
      Commits
    
    
            Show all changes
          
          
            13 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      655f306
              
                Create file and associated navigation item
              
              
                yaningo af041d2
              
                Adding steps to find IDs
              
              
                yaningo 6dcf1d8
              
                Also including alternative methods
              
              
                yaningo cacc879
              
                Adding screenshots
              
              
                yaningo 3a956de
              
                Adding correct steps for getting pipeline ID from job page
              
              
                yaningo 085b62e
              
                DRY-ing and adding screenshots
              
              
                yaningo 75395a5
              
                Rewording and adding xref
              
              
                yaningo 8f412d4
              
                Rewording and fixing xref hash
              
              
                yaningo f140115
              
                Fixing typos
              
              
                yaningo 11553f8
              
                Tweaking content and behaviour
              
              
                yaningo c4267c2
              
                Merge branch 'main' into DOCSS-1898-create-a-how-to-find-ids-page
              
              
                yaningo 13c5779
              
                Adding note about using the APIs
              
              
                yaningo 5d755c3
              
                Merge branch 'main' into DOCSS-1898-create-a-how-to-find-ids-page
              
              
                yaningo File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
      
      Loading
      
  Sorry, something went wrong. Reload?
      Sorry, we cannot display this file.
      Sorry, this file is invalid so it cannot be displayed.
      
    
      
      Loading
      
  Sorry, something went wrong. Reload?
      Sorry, we cannot display this file.
      Sorry, this file is invalid so it cannot be displayed.
      
    
      
      Loading
      
  Sorry, something went wrong. Reload?
      Sorry, we cannot display this file.
      Sorry, this file is invalid so it cannot be displayed.
      
    
      
      Loading
      
  Sorry, something went wrong. Reload?
      Sorry, we cannot display this file.
      Sorry, this file is invalid so it cannot be displayed.
      
    
      
      Loading
      
  Sorry, something went wrong. Reload?
      Sorry, we cannot display this file.
      Sorry, this file is invalid so it cannot be displayed.
      
    
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| = How to find IDs | ||
| :page-platform: Cloud | ||
| :page-description: "This page describes how customers can find IDs of various CircleCI elements." | ||
| :experimental: | ||
| 
     | 
||
| You may need to find the ID of a specific CircleCI element to perform various actions, including: | ||
| 
     | 
||
| - Making a request to the CircleCI API. | ||
| - Running a command from the local CircleCI CLI. | ||
| - Identifying a CircleCI element in logs or webhook payload. | ||
                
      
                  yaningo marked this conversation as resolved.
               
          
            Show resolved
            Hide resolved
         | 
||
| == Get IDs from the built-in environment variables | ||
| 
     | 
||
| xref:reference:ROOT:variables.adoc#built-in-environment-variables[Buit-in environment variables], scoped at the job level, include the following IDs: | ||
| 
     | 
||
| - `CIRCLE_ORGANIZATION_ID`: The organization ID. | ||
| - `CIRCLE_PROJECT_ID`: The project ID. | ||
| - `CIRCLE_PIPELINE_ID`: The pipeline ID. | ||
| - `CIRCLE_WORKFLOW_ID`: The workflow ID. | ||
| - `CIRCLE_WORKFLOW_JOB_ID`: The job ID. | ||
| 
     | 
||
| To view all environment variables available at the job level, follow these steps: | ||
| 
     | 
||
| . Navigate to the pipelines page of your project. | ||
                
      
                  yaningo marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| . Expand a workflow run. | ||
| . Select a job from that workflow run. | ||
| . On the job page, expand the menu:Preparing environment variables[] step. | ||
| . Locate the relevant environment variable(s) and note the associatedvalue(s). | ||
                
      
                  yaningo marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| image::guides:ROOT:ids-from-env-vars.png[IDs available from built-in environment variables] | ||
| 
     | 
||
| == Find your user ID | ||
| 
     | 
||
| The user ID is a unique identifier for a user. Follow these steps to find it in the CircleCI web app: | ||
| 
     | 
||
| . In the CircleCI application, go to your link:https://app.circleci.com/settings/user[User settings]. | ||
                
      
                  yaningo marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| . On the menu:Account Integrations[] page, locate the **User ID** label. | ||
| . Note the value or select the btn:[Copy] icon next to your user ID. | ||
| 
     | 
||
| 
     | 
||
| == Find an organization ID | ||
| 
     | 
||
| The organization ID is a unique identifier for an organization. The organization ID is available in the `CIRCLE_ORGANIZATION_ID` xref:get-ids-from-the-built-in-environment-variables[built-in environment variable]. Alternatively, you can follow these steps to find it in the CircleCI web app: | ||
| 
     | 
||
| . Navigate to menu:Organization Settings[Overview] in the CircleCI web app. | ||
| . Note the value or select the btn:[Copy] icon next to the organization ID. | ||
| 
     | 
||
| 
     | 
||
| == Find a project ID | ||
| 
     | 
||
| The project ID is a unique identifier for a project. The project ID is available in the `CIRCLE_PROJECT_ID` xref:get-ids-from-the-built-in-environment-variables[built-in environment variable]. Alternatively, you can follow these steps to find it in the CircleCI web app: | ||
| 
     | 
||
| include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[] | ||
| 
     | 
||
| . On the menu:Overview[] page, note the value or select the btn:[Copy] icon next to the project ID. | ||
| 
     | 
||
| 
     | 
||
| == Find a pipeline ID | ||
| 
     | 
||
| The pipeline ID is a unique identifier for a pipeline that has been triggered. The pipeline ID is available in the `CIRCLE_PIPELINE_ID` xref:get-ids-from-the-built-in-environment-variables[built-in environment variable]. Alternatively, you can follow these steps to find it in the CircleCI web app: | ||
| 
     | 
||
| 
     | 
||
| [tabs] | ||
| ==== | ||
| From the pipelines dashboard:: | ||
| + | ||
| . Navigate to the pipelines page of your project. | ||
| . Select the ellipsis image:guides:ROOT:icons/more.svg[more icon, role="no-border"] next to any workflow run of the pipeline. | ||
| . In the contextual menu, select btn:[Copy Pipeline ID]. | ||
| + | ||
| image::guides:ROOT:pipeline-id.png[Copy pipeline ID from pipelines dashboard] | ||
| From the workflow page:: | ||
| + | ||
| . Navigate to the pipelines page of your project. | ||
| . Select any workflow run of the pipeline you want to find the ID for. | ||
| . On the workflow page, select the ellipsis image:guides:ROOT:icons/more.svg[more icon, role="no-border"] at the top-right of the page (next to the btn:[Rerun] button). | ||
| . In the contextual menu, select btn:[Copy Pipeline ID]. | ||
| + | ||
| image::guides:ROOT:pipeline-id-from-workflow.png[Copy pipeline ID from workflow page] | ||
| From the job page:: | ||
| + | ||
| . Navigate to the pipelines page of your project. | ||
| . Select any workflow run from the pipeline you want to find the ID for. | ||
| . Select any job from that workflow run. | ||
| . On the job page, select the ellipsis image:guides:ROOT:icons/more.svg[more icon, role="no-border"] at the top-right of the page (next to the btn:[Rerun] button). | ||
| . In the contextual menu, select btn:[Copy Pipeline ID]. | ||
| + | ||
| image::guides:ROOT:pipeline-id-from-job.png[Copy pipeline ID from job page] | ||
| ==== | ||
| 
     | 
||
| 
     | 
||
| 
     | 
||
| == Find a workflow ID | ||
| 
     | 
||
| The workflow ID is a unique identifier for a workflow that has been triggered. The workflow ID is available in the `CIRCLE_WORKFLOW_ID` xref:get-ids-from-the-built-in-environment-variables[built-in environment variable]. Alternatively, you can follow these steps to find it in the CircleCI web app: | ||
| 
     | 
||
| [tabs] | ||
| ==== | ||
| From the workflow URL:: | ||
| + | ||
| . Navigate to the pipelines page of your project. | ||
| . Select the workflow run you want to find the ID for. | ||
| . Check the URL of the page. The workflow ID is the last alphanumeric string of the URL, after the `/workflows/` string. | ||
| + | ||
| image::guides:ROOT:workflow-id-from-workflow-url.png[Get workflow ID from workflow page URL] | ||
| From the job URL:: | ||
| + | ||
| . Navigate to the pipelines page of your project. | ||
| . Select the workflow run you want to find the ID for. | ||
| . Select any job from that workflow run. | ||
| . Check the URL of the page. The workflow ID is the alphanumeric string of the URL located between the `/workflows/` and the `/jobs/` strings. | ||
| + | ||
| image::guides:ROOT:workflow-id-from-job-url.png[Get workflow ID from job page URL] | ||
| ==== | ||
| 
     | 
||
| == Find a pipeline definition ID | ||
| 
     | 
||
| The pipeline definition ID is a unique identifier for a pipeline definition. Follow these steps to find it in the CircleCI web app: | ||
| 
     | 
||
| include::guides:ROOT:partial$app-navigation/steps-to-project-settings.adoc[] | ||
| 
     | 
||
| . Navigate to the menu:Project Setup[] page. | ||
| . Locate the pipeline definition you want to find the ID for. | ||
| . Note the value below the pipeline name or select the btn:[Copy] icon next to the pipeline definition ID. | ||
| 
     | 
||
| image::guides:ROOT:orchestrate-and-trigger/pipeline-definition-id.png[Get pipeline definition ID] | ||
| 
     | 
||
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.