# API Management
The **API Management** module in ReleaseOwl provides a comprehensive set of tools to streamline the management of SAP API artifacts. From synchronizing and configuring API proxies to tracking revisions and managing deployments across environments, this module ensures efficient control over your API landscape. It supports artifact promotion, revision history tracking, deployment validation, and environment-specific configurations.
### Synchronize API Artifacts
To sync API artifacts from SAP API Management:
1. Navigate to the **Project View**.
2. Under the **Build** section, click on **API Management**.
3. Click **Add Artifacts**. The system displays newly created artifacts that are not available in **ReleaseOwl** in separate tabs based on the selected artifact type, such as API Proxies, API Providers, Key Value Maps (KVMs), and Products.
* **API Proxies**
* **API Providers**
* **Key Value Maps (KVMs)**
* **Products**
4. Select the required artifacts from the respective tab.
5. Click **Add** to synchronize the selected artifacts.
6. These artifacts are retrieved from the registered SAP API Management environment and reflected within ReleaseOwl.
#### Sync History
To track previous synchronizations:
* Click on **Sync History** to view a detailed log of all synchronization activities performed within the project.
* If any API artifact fails during the artifact add process, the status will be displayed as **COMPLETED\_WITH\_ERRORS**.
* To view the failure details:
* Locate the artifact with the status **COMPLETED\_WITH\_ERRORS**.
* Click **Error Details** corresponding to the artifact.
* A **Failure Details** pop-up window will be displayed with the error message and additional information about the failed artifact configuration.
### **Artifact Actions**
Based on the type of artifact, the following actions are available:
* **Sync** – Re-fetch the latest version of the artifact.
* **Configure** – Modify environment-specific configuration parameters.
* **Revisions** – View available revisions of the artifact.
* **Deployment History** – Track deployment activity across stages.
* **Download** –Download the API Proxy as a ZIP file for backup or inspection.
* **Remove from Project** - Removes the selected artifact from the current project. The artifact can be added again later if required.
#### **API Proxies**
The **API Proxies** section in ReleaseOwl allows users to view, synchronize, and configure API Proxy artifacts retrieved from the integrated SAP API Management environments.
**Sync**
The **Sync** option is used to fetch the latest version of API Proxy artifacts from the registered SAP API Management environment.
* Click **Sync** to refresh and retrieve the most up-to-date API Proxy definitions.
* This ensures that ReleaseOwl reflects the current state of artifacts across environments.
**Configure**
**Configure** means **setting up or modifying values** of an artifact so that it works correctly in a specific environment.
To configure an API Proxy artifact in ReleaseOwl:
1. Navigate to the **API Proxies** tab.
2. Locate the required API Proxy.
3. Click the **Actions** button.
4. Select **Configure**.
{% hint style="info" %}
**Note:** The **Development (Dev) environment is read-only** and does not allow modification.
{% endhint %}
**Updating Configuration Values**
To modify configuration values for non-Dev environments:
1. Click the **Edit** (pencil) icon next to the required field.
2. Update the necessary configuration parameters.
3. Click **Save** to persist changes.
**Target EndPoint Configuration**
Use the **Target Endpoint** tab to define and manage backend endpoint values for each named target endpoint.
1. Select the required **Target Endpoint** from the dropdown list.
2. Modify the necessary fields by clicking the **Edit** (pencil) icon next to each field.
3. Update the required endpoint configuration values.
4. Click **Save** to persist the changes for the selected target endpoint.
{% hint style="info" %}
**Definition:** A ***Target Endpoint*** is the backend service to which the API Proxy forwards client requests. The client interacts with the proxy URL, and the request is internally routed to the defined target endpoint.
{% endhint %}
**Host Alias Configuration**
The **Host Alias** tab allows you to define environment-agnostic logical mappings for backend hostnames, enhancing flexibility during API deployments.
To configure host aliases:
1. Navigate to the **Host Alias** tab.
2. Click the **Edit** button.
3. In your target environment, multiple host aliases may be configured. If you want to deploy your API proxy to a specific host alias, you can specify the desired host alias in the **Configure** section.
4. Save your configuration by clicking the **Save** button.
**Revisions**
**Revisions** represent versioned snapshots of API Management artifacts in **ReleaseOw**l. Whenever changes are made such as updating configurations, modifying endpoints, policies, or attribute values and saved, a new revision is automatically created to capture those updates
To perform revisions, follow these steps:
* Click on the "**Revisions**" button.
Within the Revisions section, the following options are available:
* **Compare Environments**
* **Compare Versions**
* **Assign User Story**
* **Unassign User Story**
* **Additional configuration actions**
**Compare Environments:**
The **Compare Environments** option allows you to compare the source version of an API Proxy in the **Source Environment** with the active version in the **Destination Environment**.
To initiate:
* Click **Compare Environments**
* Select the **Source Environment** and **Destination Environment**
* Click **Submit**
**Compare Versions**
The **Compare Versions** option in ReleaseOwl allows you to compare two different versions of an API Proxy artifact, enabling you to identify changes and analyze differences between versions before proceeding with further actions such as deployment or promotion.
To perform a comparison:
* Ensure that you select **two versions of the same artifact**.
* The system will highlight the differences between the selected versions, enabling you to track configuration changes effectively.
**Assign User Story**
The **Assign User Story** option allows you to assign one or more user stories to yourself or another team member for better ownership and tracking. To assign, click on the **Assign User Story** button, select the required user stories from the list, and click **Assign User Story** again. In the assignment panel, choose the desired user from the dropdown list to complete the assignment.
**Unassign User Story**
The **Unassign User Story** option allows you to remove the current assignment of one or more user stories. To unassign, click on the **Unassign User Story** button, select the required user stories from the list, and click **Unassign User Story** again to release them from their current assignees.
* Additionally, you can perform configuration actions and download the selected API Proxy artifact as a ZIP file within the Revisions section.
#### API Provider
The **API Provider** section in **ReleaseOwl** is used to configure provider-specific parameters that define how API artifacts interact with backend services across different environments.
**Sync**
The **Sync** option allows users to fetch the latest API Provider configurations from the registered SAP API Management environment.
* Click **Sync** to retrieve the most recent provider entries.
* This ensures that the configuration in **ReleaseOwl** is up to date with the source environment.
**Configure**
**Configure** means **setting up or modifying values** of an artifact so that it works correctly in a specific environment
To configure an API Provider in ReleaseOwl:
1. Navigate to the **API Provider** tab.
2. Select the required provider entry.
3. Click the **Actions** button.
4. Select **Configure**.
**Configuration Screen**
The configuration screen displays the API Provider entries across multiple environments (e.g., QA, Production) that are part of the deployment landscape. Each provider configuration is represented as **entries**, where environment-specific values can be maintained.
The **Provider Name** can be modified for the target environment during deployment using the **Edit** option, allowing environment-specific customization of the provider configuration.
For example, if the provider name in the **Dev** environment is *NorthWindProvider*, it can be updated for the **QA** environment to *NorthWindProvider\_QA*. During deployment, the provider will be created in the target environment with the updated name.
To modify configuration values for non-Dev environments:
1. Click the **Edit (pencil)** icon next to the desired field.
2. Update the required parameters.
3. Click **Save** to persist the changes.
{% hint style="info" %}
**Note:** If the provider includes authentication settings, these may be overridden in the target environment during deployment. After deployment, it is recommended to manually update the authentication details in the target environment.
{% endhint %}
{% hint style="info" %}
**Note:** The **Development (Dev) environment is read-only** and cannot be modified.
{% endhint %}
#### Key Value Maps
The **Key Value Maps (KVM)** section in ReleaseOwl is used to manage environment-specific key-value pairs that are consumed by API Proxies at runtime. Each KVM consists of multiple **keys**, with corresponding **values maintained per environment** (e.g., Dev, QA, Prod).
**Sync**
The **Sync** option retrieves the latest KVM artifacts from the registered SAP API Management environment.
* Click **Sync** to refresh and fetch the most recent KVM definitions.
* Ensures **ReleaseOwl** reflects the current state of KVMs from the source system.
**Configure**
**Configure** means **setting up or modifying values** of an artifact so that it works correctly in a specific environment.
To configure key Value Maps in ReleaseOwl:
1. Navigate to the **Key Value Map**s tab.
2. Select the required provider entry.
3. Click the **Actions** button.
4. Select **Configure**.
**Configuration Screen**
When a KVM is selected, the configuration is displayed under the **Entries** tab.
* Each row represents a **key.**
* Each column represents an **environment**
* Values are maintained **per environment** for each key.
**Updating KVM Entries**
To update values:
1. Locate the required **key** in the Entries table.
2. Identify the target **environment column** (e.g., QA, Prod).
3. Click the **Edit (pencil) icon** under **Modify Values**.
4. Update the value directly in the editable field.
5. Click **Save** to persist the changes.
#### API Product
An **API Product** in ReleaseOwl represents a collection of API Proxies bundled together and exposed for consumption.
**Sync**
The **Sync** option is used to fetch the latest API Product artifacts from the registered SAP API Management environment.
* Click **Sync** to retrieve the most recent API Product definitions.
* Ensures that ReleaseOwl reflects the current state of API Products from the source system.
#### Configuring an API Product
To configure an API Product in ReleaseOwl:
1. Navigate to the **API Product** tab.
2. Select the required API Product.
3. Click the **Actions** button.
4. Select **Configure**.
#### Configuration
The configuration screen displays the API Product across multiple environments (e.g., Dev, QA, Production) that are part of the deployment landscape.
#### Custom Attributes
Within the **Configure** section, the **Custom Attributes** tab allows you to define and manage environment-specific attribute values.
* Each row represents an **attribute key.**
* Each column represents an **environment**.
* Values can be maintained independently per environment.
#### Updating Custom Attributes
To update attribute values:
1. Navigate to the **Custom Attributes** tab under **Configure**.
2. Locate the required attribute.
3. Click the **Edit (pencil) icon** under **Modify Values**.
4. Update the value in the desired environment column.
5. Click **Save** to persist the changes.
#### Revisions
**Revisions** represent versioned snapshots of API Management artifacts in ReleaseOwl. Whenever changes are made—such as updating configurations, modifying endpoints, policies, or attribute values—and saved, a new revision is automatically created to capture those updates. This applies to all supported artifacts, including:
* API Providers
* Key Value Maps (KVM)
* API Products
To perform revisions, follow these steps:
* Click on the "**Revisions**" button.
The following actions are available:
* **Assign User Story**
* **Unassign User Story**
* **Additional configuration actions**
**Assign User Story**
You can assign a user story to yourself or another team member for better ownership and tracking.\
To assign a user story, click on the **Assign User Story** button. Select the required user stories from the list, then click on **Assign User Story** again. In the assignment panel, choose the desired user from the dropdown list to complete the assignment.
**Unassign User Story**\
To remove the assignment of a user story, click on the **Unassign User Story** button. Select the required user stories from the list and click on **Unassign** **User Story** again to release them from their current assignees.
* Additionally, within the **Revisions** section, you can perform **configuration actions and download the selected API artifact as a ZIP file**.
#### Deployment History
* Displays the recent deployment history of API Management artifacts in ReleaseOwl, including the artifact name, artifact type (API Proxy, API Provider, Key Value Map, API Product), associated user story, target environment, deployment timestamp, and deployment status, providing a consolidated and traceable view of deployment activities across all supported artifact types.
### Deploy Logs
* **Deploy Status**: Reflects the final deployment status of the API artifact to the target environment.
* **Already Deployed**: Indicates that the API artifact was previously deployed, either as part of a retry or through manual completion. This status helps avoid redundant deployments and ensures clarity during re-runs.
* **Manual Completion**: If a deployment fails in **ReleaseOwl**, but the artifact has been successfully deployed or addressed directly in the backend system (e.g., **SAP API Management**) through manual intervention, users can use the **Manual Completion** option in **ReleaseOwl** to mark the deployment step as completed.
**To perform manual completion:**
1. Click the **Mark as Complete** button to proceed with the pipeline.
2. After marking as complete, click the **Continue** button to resume the previously failed deployment stage.
3. You will see a confirmation that the **deployment has resumed successfully**.
4. The **deployment status** will then update to **Completed**, indicating that the process finished successfully.
**Retry Button**\
Allows users to retry a failed deployment or re-execute a failed stage of the pipeline.
### Deployment Notification
* After deploying the artifacts, you will receive a notification email containing the deployment details, including the user story ID, artifact type, version ID, and deployment status.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://releaseowl.gitbook.io/releaseowl-docs/releaseowl-user-guide/sap-api-management/api-management.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
