C4C7OPS Microservices API

List Services by Category

Returns all services that belong to the specified service category.

When to Use

Use this endpoint to discover which services of a given type (e.g. microservice, frontend, app) are registered in your account.

Parameters

Responses

• `200 OK` — Returns an array of service objects matching the requested category.

Notes

• The category values are case-sensitive; use the exact identifier returned by the platform.

List Environments

Returns every environment provisioned for the authenticated account.

When to Use

Call this endpoint to enumerate available environments (e.g. development, staging, production) and obtain their IDs for use in subsequent operations.

Parameters

This endpoint takes no parameters.

Responses

• `200 OK` — Returns a list of environment objects, each containing at least an id and a name.

Notes

• Store the environment IDs locally; most deploy and configuration endpoints require environment_id as a path parameter.

Create Deploy

Triggers a new deployment for a microservice.

When to Use

Use this endpoint to initiate a deploy after updating code, configuration, or environment variables.

Request Body (application/json)

Supply a JSON payload specifying the target microservice, environment, and any deploy options defined by the schema (e.g. image tag, commit reference).

{
  "microservice_id": "string",
  "environment_id": "string"
}

Responses

• `200 OK` — Deploy was created successfully. The response includes a deploy_id you can use to track progress.

Notes

• After creation, poll GET /b1/microservices/ms/deploy/{deploy_id}/status to monitor the deploy lifecycle.
• Ensure environment variables and runtime settings are configured before deploying.

Get Deploy Status

Returns a step-by-step status map for a specific deployment.

When to Use

Poll this endpoint after creating a deploy to track the progress of each stage (e.g. build, push, rollout).

Parameters

Responses

• `200 OK` — Returns a map of deploy step names to their current statuses (e.g. pending, running, succeeded, failed).

Notes

• Implement polling with a reasonable interval (e.g. 5–15 seconds) to avoid rate-limiting.
• A step marked as failed typically indicates a build or rollout error; check platform logs for details.

List Deploys

Returns the deployment history for a specific microservice in a specific environment.

When to Use

Use this endpoint to audit past deployments, compare versions, or find a deploy_id for status checks.

Parameters

Responses

• `200 OK` — Returns a list of deploy objects, each including at least deploy_id, status, and timestamp.

Notes

• Results are typically ordered by creation date (newest first).
• Use this list to locate a deploy_id before calling GET /b1/microservices/ms/deploy/{deploy_id}/status.

Create or Update Environment Variables

Creates or updates environment variables for a microservice using a PUT (upsert) semantic.

When to Use

Call this endpoint when you need to set or modify environment-level variables (API keys, feature flags, connection strings, etc.) before or between deployments.

Request Body (application/json)

Provide a JSON object containing the variables to upsert. The exact schema is defined in the OpenAPI contract.

{
  "microservice_id": "string",
  "environment_id": "string",
  "variables": {
    "KEY": "value"
  }
}

Responses

• `200 OK` — Environment variables were saved successfully.

Notes

• This operation performs an upsert: existing keys are overwritten, new keys are added.
• Changes to environment variables typically require a new deploy to take effect at runtime.

Get Environment Variables

Retrieves the environment variables configured for a specific microservice and environment.

When to Use

Call this endpoint to inspect current environment variables before updating them or to verify that a recent upsert was applied correctly.

Parameters

Responses

• `200 OK` — Returns the environment variable key-value map for the specified scope.

Notes

• Sensitive values (secrets, API keys) may be masked in the response depending on platform security policies.
• Cross-reference with PUT /b1/microservices/ms/envs for the write counterpart.

Create or Update Runtime Settings

Creates or updates runtime configuration for a microservice without requiring a new deployment.

When to Use

Use this endpoint to adjust operational parameters (log levels, cache TTLs, feature toggles) that the service reads at runtime.

Request Body (application/json)

Provide a JSON payload with the settings to upsert. Refer to the OpenAPI schema for the full structure.

{
  "microservice_id": "string",
  "environment_id": "string",
  "settings": {
    "log_level": "info"
  }
}

Responses

• `200 OK` — Runtime settings were saved successfully.

Notes

• Unlike environment variables, runtime settings are designed to be consumed without restarting the service, depending on your application architecture.
• Validate the response against the OpenAPI schema to confirm persistence.

Get Runtime Settings

Retrieves the runtime configuration for a specific microservice and environment.

When to Use

Call this endpoint to inspect the current runtime settings — such as log levels, cache configuration, or feature toggles — before updating them or to verify a recent change.

Parameters

Responses

• `200 OK` — Returns the runtime settings object for the specified scope.

Notes

• Runtime settings are distinct from environment variables and are designed to take effect without a redeploy.
• Use PUT /b1/microservices/ms/runtime-settings as the write counterpart.