ApiEnvironmentLink

The ApiEnvironmentLink allows associating an API with an environment. This association grants the defined permissions for one or more APIs within that environment. You can also assign permission to an API for API Platform environments.

To create a valid ApiEnvironmentLink, it is necessary that:

  • The API exists;

  • The environment exists.

ApiEnvironmentLink .yaml File Structure (apply command)

apiVersion: api-management.sensedia.com/v1
kind: ApiEnvironmentLink
metadata:
  # Open text description with only example values
  type: production
  owner: engineering
spec:
  # Identifying fields
  apiRef:
     name: "Open Banking API"
     version: "1.0.0"
  environmentRef:
     name: "Production"

After specifying YAML, you can:

  • apply it via command apply.

  • associate an API with an environment with the command $ ssd api-management link api "Open Banking" --api-version 1.0.0 --to-environment "Production"

Assigning multiple environments to an API

```
apiVersion: api-management.sensedia.com/v1
kind: ApiEnvironmentLink
metadata:
  # Open text description with example values only
  type: production
  owner: engineering
spec:
  # Identifying fields
  apiRef:
     name: "Open Banking API"
     version: "1.0.0"
  environmentRef:
  - name: "Production"
  - name: "Development"
  - name: "Sandbox"
```
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]