Skip to main content

Authorization

Follow this guide to create a new Codefresh credential that will allow Nexla to authenticate to and exchange data with your Codefresh account.
codefresh_api_auth.png

Codefresh

Prerequisites​

Codefresh authenticates API requests using an API key that is passed in the Authorization header of each request. Before creating a credential in Nexla, you must have an active Codefresh account and generate an API key with the scopes required for the operations you intend to perform.

Obtain a Codefresh API Key​

API keys are generated from your Codefresh user settings. Each key is tied to your account and carries the scopes (permissions) that you assign when it is created.

  1. Sign in to your Codefresh account at https://g.codefresh.io.

  2. Navigate to your user settings by clicking your avatar in the lower-left corner and selecting User Settings, or by going directly to https://g.codefresh.io/user/settings.

  3. Scroll down to the API Keys section, and click the Generate button.

  4. Enter a user-friendly Key Name without spaces (e.g., nexla-integration) so that you can identify the key later.

  5. Select the Scopes that the key requires. For a Nexla integration that reads pipeline and build data and manages pipelines, projects, contexts, and triggers, select the scopes corresponding to those resources. Selecting all scopes grants full access; for tighter security, select only the scopes needed for your use case.

  6. Click Create to generate the key. Codefresh displays the key in the API Key field.

  7. Copy the key immediately and store it in a secure location, as it is used to authenticate Nexla with the Codefresh API.

    Treat your API key like a password. Anyone with the key can perform actions in your Codefresh account up to the scopes assigned to it. Assign only the scopes required for your integration, and rotate or revoke keys that are no longer in use.

For complete information about Codefresh API authentication, refer to the Codefresh API integration documentation.

Create a Codefresh Credential​

  • To create a new Codefresh credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Authentication Settings​

Codefresh uses API key authentication. Provide the API key you generated in the prerequisites along with the API base URL for your Codefresh instance.

  1. Enter the API key you generated in your Codefresh user settings in the API Key Value field. Nexla includes this value in the Authorization header of every request to authenticate with the Codefresh API. This value is stored securely and is treated as a secret.

  2. Enter the Codefresh API base URL in the Base URL field. For the Codefresh SaaS platform, this is https://g.codefresh.io/api, which is the default value. If you use a dedicated or on-premises Codefresh installation, enter the base URL for your environment instead.

    The base URL is the common prefix for all Codefresh API endpoints. Nexla appends endpoint-specific paths (such as /pipelines or /workflow) to this value when making API calls.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.