Image Removed

Overview

Environments can be pinned. Then they will be displayed as tiles at Home as well.

The " Environments " management interface is a component , as part of an API management platform that enables , allows users to oversee monitor different deployment environments that serve as instances for deploying, testing and monitoring APIs. These environments are instances where APIs can be deployed, tested, and monitored.

Pinned Environments Section

At the top, we have the "PINNED ENVIRONMENTS" section which highlights key environments for quick access. Environments such as "AWS", "Azure", and "L7" are displayed with a clear indication of whether they have an associated monitoring agent. The presence of an "Agent" status suggests the possibility of enhanced monitoring features for the respective environment. Users can manage these pinned environments, including removing them by clicking the "Delete" button.

critical to ensure the seamless transition of APIs from the development to production phase, facilitate rigorous testing and enable efficient monitoring of API performance and behaviour. The environments give users centralised control over the entire API lifecycle, streamlining the management process and improving operational efficiency.

All your Environments

Below, there is a table listing all environments. Each row provides details about a specific environment, such as:

• Name: The designated name of the environment (e.g., "AWS", "Azure").

• Pinned: This column shows whether the environment is pinned for quick access, with a green pin icon indicating it is pinned.

• Stage: Indicates the stage of deployment, with all listed as "PRODUCTION" in this view.

• Agent: Denotes if a monitoring agent is associated with the environment, which is currently "No Agent" for all.

• Status: Reflects the current operational status of the environment. Here, each environment is marked as "Active".

In the top right, there is a "Register Environment" button, allowing users to add new environments to the platform.

Technical Name

The technical name of an environment must be unique.

Display Name

The display name can differ from the technical name and does not have to be unique.

Url

The base URL at which the APIs from this environment are made available. It is used to generate the full API Url that is displayed to users after subscribing to an API. Environment Urls

Platform Type

The platform type of the environment cannot be changed afterwards.

Agent

Here you can see the status of the agent. Platforms, Environments and Stages

Status

If the environment is inactive, the agent will not be able to connect. /wiki/spaces/OB/pages/7981826108

Production

The Stage of the environment.

Color, Symbol

This allows you to distinguish your environments more easily.

Image Added

Interface Features

• Search Bar: Enables filtering the list of environments by name.

• Pagination Controls: Allow navigation through multiple pages if there are more environments than can be displayed on a single page.

• Edit and Delete: The interface likely has edit and delete capabilities for each environment, as suggested by the interactive elements in the "Pinned" and "Status" columns.

Pinned Environments Section

At the top, we have the "PINNED ENVIRONMENTS" section which highlights key environments for quick access. Environments such as "AWS", "Azure", and "L7" are displayed with a clear indication of whether they have an associated monitoring agent. The presence of an "Agent" status suggests the possibility of enhanced monitoring features for the respective environment. Users can manage these pinned environments, including removing them by clicking the "Delete" button.

Detailed View Navigation Bar

Image Added

Clicking on an environment takes you to the detailed view of this environment. This detailed view contains a further navigation bar with these options.

Overview

A tile of the current environment. This contains the colour and symbol, the display name and the agent status.

General

This category houses the navigation pane for the application, which includes:

• Overview: Shows a general summary.

• Deployments: Shows all deployments in this environment.

• Access Management: Which organisations are allowed to subscribe to or publish their APIs and API products.

• Settings: Where configuration settings for the environment are managed.

Register a new Environment

Press the "Register Environment" button at the top right and follow the wizard. For each platform, we have an additional instruction article for you.