Ocelot

Ocelot is an open-source API Gateway built with .NET for microservices architectures. It provides routing, authentication, rate limiting, load balancing, and service discovery features for managing and securing APIs in .NET ecosystems.

2 APIs 0 Features

.NETAPI GatewayMicroservicesOpen Source

APIs

Ocelot API Gateway

Ocelot is an open-source .NET API Gateway that provides routing, authentication, authorization, rate limiting, load balancing, caching, and service discovery for microservices a...

Ocelot Administration API

The Ocelot Administration API allows runtime changes to gateway configuration via an authenticated HTTP API. It supports updating routes and clearing cache regions without resta...

Collections

Ocelot Administration API

OPEN

Pricing Plans

Ocelot Plans Pricing

3 plans

PLANS

Rate Limits

Ocelot Rate Limits

5 limits

RATE LIMITS

FinOps

Ocelot Finops

FINOPS

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Ocelot Administration API
  version: 1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Issue an admin access token
      type: http
    http:
      method: POST
      url: http://localhost:5000/administration/connect/token
      body:
        type: form-urlencoded
        data:
        - name: client_id
          value: ''
        - name: client_secret
          value: ''
        - name: scope
          value: ''
        - name: grant_type
          value: ''
    docs: Issues an OAuth 2.0 access token using the client credentials flow. The returned bearer token must be supplied to
      subsequent Administration API calls.
- info:
    name: Configuration
    type: folder
  items:
  - info:
      name: Get current Ocelot configuration
      type: http
    http:
      method: GET
      url: http://localhost:5000/administration/configuration
    docs: Returns the active Ocelot file configuration in the same JSON shape used to bootstrap the gateway.
  - info:
      name: Overwrite Ocelot configuration
      type: http
    http:
      method: POST
      url: http://localhost:5000/administration/configuration
      body:
        type: json
        data: '{}'
    docs: Replaces the active Ocelot configuration with the supplied FileConfiguration document. The Ocelot process must have
      write permissions for the configuration file on disk.
- info:
    name: Cache
    type: folder
  items:
  - info:
      name: Clear an output cache region
      type: http
    http:
      method: DELETE
      url: http://localhost:5000/administration/outputcache/:region
      params:
      - name: region
        value: ''
        type: path
        description: Cache region name as configured in FileCacheOptions
    docs: Clears the specified output cache region. When a backplane is configured, all gateway instances clear the region.
bundled: true