Netcore Cloud Configuration API

The Configuration API from Netcore Cloud — 6 operation(s) for configuration.

Operations 10

POST /config/api-keys Create an API key #
GET /config/api-keys List API keys #
DELETE /config/api-keys/{id} Delete an API key #
GET /config/ip-whitelist Get IP whitelist #
PUT /config/ip-whitelist Update IP whitelist #
GET /config/smtp Get SMTP configuration #
PUT /config/smtp Update SMTP configuration #
GET /config/incoming-auth List incoming auth entries #
PUT /config/incoming-auth Create or update incoming auth #
POST /config/api-keys/{id}/reset Regenerate an API key #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-campaign-specific-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-audience-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-filter-block-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-output-block-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-conversion-tracking-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-google-analytics-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-route-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-route-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-rule-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-rule-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-incoming-auth-upsert-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-netcore-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-payment-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-template-list-success-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-refund-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-consent-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-refund-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-flow-list-success-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-json-single-api-v2-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/netcorecloud/json-schema/netcorecloud-dlrreport-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/netcorecloud:netcorecloud-configuration-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netcorecloud-configuration-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orbit Router Configuration API
  version: 1.0.0
  description: Complete API specification for the Orbit Router email routing platform.
  contact:
    name: Orbit Engineering
  license:
    name: Proprietary
servers:
- url: https://orbitus.netcorecloud.com
  description: Production — Orbit Engine (HTTP Relay)
- url: https://orbitus.netcorecloud.com/apiorbit
  description: Production — Orbit Backend (Config & Management)
security: []
tags:
- name: Configuration
paths:
  /config/api-keys:
    post:
      operationId: createApiKey
      tags:
      - Configuration
      summary: Create an API key
      description: 'Returns the full plaintext API key **once**. The backend stores only the SHA-256 hash.

        Store your key securely immediately.'
      security:
      - BackendJWT: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - type
              properties:
                name:
                  type: string
                type:
                  type: string
                  enum:
                  - http
                  - smtp
      responses:
        '201':
          description: API key created (includes full plaintext key).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreated'
    get:
      operationId: listApiKeys
      tags:
      - Configuration
      summary: List API keys
      description: Returns masked key previews only.
      security:
      - BackendJWT: []
      responses:
        '200':
          description: List of API keys (masked).
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiKeySummary'
  /config/api-keys/{id}:
    parameters:
    - $ref: '#/components/parameters/ResourceId'
    delete:
      operationId: deleteApiKey
      tags:
      - Configuration
      summary: Delete an API key
      security:
      - BackendJWT: []
      responses:
        '204':
          description: API key deleted.
        '404':
          description: API key not found.
  /config/ip-whitelist:
    get:
      operationId: getIpWhitelist
      tags:
      - Configuration
      summary: Get IP whitelist
      security:
      - BackendJWT: []
      responses:
        '200':
          description: IP whitelist configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpWhitelist'
    put:
      operationId: updateIpWhitelist
      tags:
      - Configuration
      summary: Update IP whitelist
      security:
      - BackendJWT: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpWhitelist'
      responses:
        '200':
          description: IP whitelist updated.
  /config/smtp:
    get:
      operationId: getSmtpConfig
      tags:
      - Configuration
      summary: Get SMTP configuration
      security:
      - BackendJWT: []
      responses:
        '200':
          description: SMTP configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmtpConfig'
    put:
      operationId: updateSmtpConfig
      tags:
      - Configuration
      summary: Update SMTP configuration
      security:
      - BackendJWT: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmtpConfig'
      responses:
        '200':
          description: SMTP configuration updated.
  /config/incoming-auth:
    get:
      operationId: listIncomingAuth
      tags:
      - Configuration
      summary: List incoming auth entries
      description: Lists incoming auth entries for the current client.
      security:
      - BackendJWT: []
      responses:
        '200':
          description: Incoming auth entries.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IncomingAuth'
    put:
      operationId: upsertIncomingAuth
      tags:
      - Configuration
      summary: Create or update incoming auth
      security:
      - BackendJWT: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncomingAuthUpsert'
      responses:
        '200':
          description: Incoming auth created or updated.
  /config/api-keys/{id}/reset:
    parameters:
    - $ref: '#/components/parameters/ResourceId'
    post:
      operationId: resetApiKey
      tags:
      - Configuration
      summary: Regenerate an API key
      description: Generates a new key value; same ID and name. Returns the full plaintext key once.
      security:
      - BackendJWT: []
      responses:
        '200':
          description: Key regenerated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreated'
components:
  schemas:
    IncomingAuth:
      type: object
      properties:
        id:
          type: integer
        client_id:
          type: integer
        protocol_type:
          type: string
          enum:
          - smtp
          - https
        username:
          type: string
        allowed_ips:
          type: string
          description: Comma-separated IPs or `*` for wildcard.
        allowed_domains:
          type: string
          description: Comma-separated domains or `*` for wildcard.
    IncomingAuthUpsert:
      type: object
      required:
      - protocol_type
      properties:
        protocol_type:
          type: string
          enum:
          - smtp
          - https
        username:
          type: string
          description: SMTP username.
        password:
          type: string
          format: password
          description: SHA-256 hashed before storage.
        api_key:
          type: string
          description: For HTTP; hashed before storage.
        api_key_id:
          type: integer
          description: Reference to `api_keys.id`.
        allowed_ips:
          type: string
          description: Comma-separated IPs or `*`.
        allowed_domains:
          type: string
          description: Comma-separated domains or `*`.
    SmtpConfig:
      type: object
      properties:
        default_from_email:
          type: string
          format: email
        default_from_name:
          type: string
        bounce_email:
          type: string
          format: email
        max_retries:
          type: string
        retry_interval_seconds:
          type: string
    ApiKeyCreated:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        key:
          type: string
          description: Full plaintext API key (shown once).
        type:
          type: string
          enum:
          - http
          - smtp
        created_at:
          type: string
          format: date-time
    IpWhitelist:
      type: object
      properties:
        enabled:
          type: boolean
        ips:
          type: string
          description: Comma-separated IP addresses.
    ApiKeySummary:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        preview:
          type: string
          description: Masked key preview.
        type:
          type: string
          enum:
          - http
          - smtp
        created_at:
          type: string
          format: date-time
  parameters:
    ResourceId:
      name: id
      in: path
      required: true
      schema:
        type: integer
      description: Resource ID.
  securitySchemes:
    BackendJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT token obtained from `POST /auth/login`. Access token lifetime: 15 minutes.

        Claims: `user_id`, `client_id`, `role`, `jti`, `exp`, `iat`.

        '
    EngineApiKeyBearer:
      type: http
      scheme: bearer
      description: 'Engine API key via `Authorization: Bearer <api_key>` (priority 1).'
    EngineApiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Engine API key via `X-API-Key` header (priority 2).
    EngineApiKeyFallback:
      type: apiKey
      in: header
      name: api_key
      description: Engine API key via `api_key` header (priority 3, fallback).
x-readme:
  explorer-enabled: true
  proxy-enabled: true
x-provenance:
  method: searched
  source: https://emaildocs.netcorecloud.com/reference
  note: Verbatim OpenAPI fragments embedded in each ReadMe reference page on emaildocs.netcorecloud.com, merged by path. Not authored by API Evangelist.
  retrieved: '2026-10-13'