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/kloudfuse:kloudfuse-policies-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Kloudfuse Platform Policies API
  version: latest
  description: Generated by API Evangelist from the Kloudfuse API reference documentation (docs.kloudfuse.com/platform/latest/reference/api/). NOT published by Kloudfuse. Paths and methods come from the documented curl examples; request and response bodies are not modelled. Kloudfuse is deployed per customer, so the server host is the customer instance.
  x-generated-from: documentation
  x-ae-authored: true
  x-source: https://docs.kloudfuse.com/platform/latest/reference/api/
servers:
- url: https://{instance}
  variables:
    instance:
      default: your-instance.example.com
      description: Your Kloudfuse instance hostname
security:
- ServiceAccountToken: []
tags:
- name: Policies
paths:
  /rbac/policies:
    get:
      tags:
      - Policies
      summary: List Policies
      operationId: listPolicies
      description: List Policies. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
    post:
      tags:
      - Policies
      summary: Create Policy
      operationId: createPolicy
      description: Create Policy. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /rbac/policies/{policyName}:
    get:
      tags:
      - Policies
      summary: Get Policy
      operationId: getPolicy
      description: Get Policy. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
    put:
      tags:
      - Policies
      summary: Update Policy
      operationId: updatePolicy
      description: Update Policy. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
    delete:
      tags:
      - Policies
      summary: Delete Policy
      operationId: deletePolicy
      description: Delete Policy. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
  /rbac/policies/{policyName}/mappings:
    get:
      tags:
      - Policies
      summary: List Policy Mappings
      operationId: listPolicyMappings
      description: List Policy Mappings. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
      - Policies
      summary: Create Policy Mapping
      operationId: createPolicyMapping
      description: Create Policy Mapping. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
  /rbac/policies/{policyName}/mappings/{principalType}/{principalId}:
    delete:
      tags:
      - Policies
      summary: Delete Policy Mapping
      operationId: deletePolicyMapping
      description: Delete Policy Mapping. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: policyName
        in: path
        required: true
        schema:
          type: string
      - name: principalType
        in: path
        required: true
        schema:
          type: string
      - name: principalId
        in: path
        required: true
        schema:
          type: string
  /rbac/users/{userEmail}/effective-policies:
    get:
      tags:
      - Policies
      summary: Get User Effective Policies
      operationId: getUserEffectivePolicies
      description: Get User Effective Policies. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: userEmail
        in: path
        required: true
        schema:
          type: string
  /rbac/service-accounts/{serviceAccount}/effective-policies:
    get:
      tags:
      - Policies
      summary: Get Service Account Effective Policies
      operationId: getServiceAccountEffectivePolicies
      description: Get Service Account Effective Policies. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
      parameters:
      - name: serviceAccount
        in: path
        required: true
        schema:
          type: string
  /rbac/allowed-labels:
    get:
      tags:
      - Policies
      summary: List Allowed Labels
      operationId: listAllowedLabels
      description: List Allowed Labels. Documented at https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      externalDocs:
        url: https://docs.kloudfuse.com/platform/latest/reference/api/policies/
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error (see API Response Codes)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        status:
          type: string
          enum:
          - error
        errorType:
          type: string
          enum:
          - BAD_REQUEST
          - UNAUTHORIZED
          - FORBIDDEN
          - NOT_FOUND
          - RESOURCE_EXHAUSTED
          - RATE_LIMITED
          - CANCELED
          - INTERNAL_ERROR
          - SERVICE_UNAVAILABLE
          - TIMEOUT
        error:
          type: string
        request_id:
          type: string
  securitySchemes:
    ServiceAccountToken:
      type: http
      scheme: bearer
      description: Kloudfuse Service Account token
    IngestApiKey:
      type: apiKey
      in: header
      name: Kf-Api-Key