Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

nOps MAP Migration API

Endpoints for managing and retrieving information about AWS Migration Acceleration Program (MAP) migration projects, including projects, products, and resources.

nOps MAP Migration API is one of 2 APIs that nOps publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include MAP Migration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://app.nops.io.

4 operations 4 paths 3 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://app.nops.io
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

nOps MAP Migration API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Nops-Api-Key (ApiKeyAuth). An API key is passed in the header as x-nops-signature (SignatureAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated from the nOps console under Organization Settings. Include this key in the X-Nops-Api-Key header for all requests.
  • SignatureAuth — Encoded signature for enhanced security. Created using a public/private key pair configured in the nOps console.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

MAP Migration 4

Endpoints for managing and retrieving information about AWS Migration Acceleration Program (MAP) migration projects, including projects, products, and resources.

GET
/c/v3/map-migration/
Nops List Map Migration Projects
listMapMigrationProjects → 200401403
GET
/c/v3/map-migration/{id}/
Nops Retrieve a Map Migration Project
getMapMigrationProject 1 param → 200401404
GET
/c/v3/map-migration/{id}/products/
Nops List Products in a Map Migration Project
listMapMigrationProducts 1 param → 200401404
GET
/c/v3/map-migration/{id}/resources/
Nops List Resources in a Map Migration Project
listMapMigrationResources 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are MapMigrationProject (5 properties), MapMigrationResource (4 properties), MapMigrationProduct (3 properties). Each schema is shown below with its type and property counts.

MapMigrationResource
object
4 properties
MapMigrationProject
object
5 properties
MapMigrationProduct
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nops-map-migration-api-openapi.yml Raw ↑

Other APIs nOps publishes across the network.

nOps Essentials Scheduler API