HTTP API Reference

This reference is generated from Rust wire types, management DTOs and the host’s route declarations. Request and response schemas use their respective Serde contracts. Expand an operation to see its parameters, payloads, status codes and referenced data structures.

Shared forwarding paths select the protocol from request headers. stream: true selects the streaming operation. SSE schemas describe each decoded data event; WebSocket schemas describe messages after the upgrade. Binary and multipart payloads retain their own content types.

The forwarding paths can also use a provider or namespace prefix. Codex-specific paths require a Codex provider name. See Routing & Endpoints for mount selection, authentication and administrative scopes.

GPROXY 4.1.10. Download JSON (OpenAPI).

Forwarding

POST /alpha/search

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	web_search	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_WebSearchRequestBody

{
  "$ref": "#/components/schemas/Input_WebSearchRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_WebSearchResponseBody

{
  "$ref": "#/components/schemas/Output_WebSearchResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /upload/v1beta/files

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	create_file	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_UploadFileMetadata

{
  "$ref": "#/components/schemas/Input_UploadFileMetadata"
}

application/octet-stream

{
  "format": "binary",
  "type": "string"
}

multipart/related

Referenced structures: Input_UploadFileForm3

{
  "$ref": "#/components/schemas/Input_UploadFileForm3"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_UploadFileResponseBody

{
  "$ref": "#/components/schemas/Output_UploadFileResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/alpha/search

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	web_search	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_WebSearchRequestBody

{
  "$ref": "#/components/schemas/Input_WebSearchRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_WebSearchResponseBody

{
  "$ref": "#/components/schemas/Output_WebSearchResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/audio/speech

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_speech	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateSpeechRequestBody

{
  "$ref": "#/components/schemas/Input_CreateSpeechRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/octet-stream

{
  "format": "binary",
  "type": "string"
}

audio/*

{
  "format": "binary",
  "type": "string"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_SpeechAudioEvent

{
  "$ref": "#/components/schemas/Output_SpeechAudioEvent"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/audio/transcriptions

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_transcription	HTTP

Parameters · Request body · Responses

Request body

multipart/form-data

Referenced structures: Input_CreateTranscriptionMultipartForm

{
  "$ref": "#/components/schemas/Input_CreateTranscriptionMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_TranscriptionDiarized, Output_TranscriptionJson, Output_TranscriptionVerbose

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_TranscriptionJson"
    },
    {
      "$ref": "#/components/schemas/Output_TranscriptionVerbose"
    },
    {
      "$ref": "#/components/schemas/Output_TranscriptionDiarized"
    }
  ]
}

application/x-subrip

{
  "type": "string"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_TranscriptionStreamEvent

{
  "$ref": "#/components/schemas/Output_TranscriptionStreamEvent"
}

text/plain

{
  "type": "string"
}

text/vtt

{
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/audio/translations

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_translation	HTTP

Parameters · Request body · Responses

Request body

multipart/form-data

Referenced structures: Input_CreateTranslationMultipartForm

{
  "$ref": "#/components/schemas/Input_CreateTranslationMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_TranslationJson, Output_TranslationVerbose

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_TranslationJson"
    },
    {
      "$ref": "#/components/schemas/Output_TranslationVerbose"
    }
  ]
}

application/x-subrip

{
  "type": "string"
}

text/plain

{
  "type": "string"
}

text/vtt

{
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/audio/voices

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_voice	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreatePromptVoiceRequestBody

{
  "$ref": "#/components/schemas/Input_CreatePromptVoiceRequestBody"
}

multipart/form-data

Referenced structures: Input_CreateSampleVoiceMultipartForm

{
  "$ref": "#/components/schemas/Input_CreateSampleVoiceMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_Voice

{
  "$ref": "#/components/schemas/Output_Voice"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/chat/completions

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai_chat	generate_content stream: true → stream_generate_content	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_GenerateContentRequestBody4

{
  "$ref": "#/components/schemas/Input_GenerateContentRequestBody4"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_GenerateContentResponseBody4

{
  "$ref": "#/components/schemas/Output_GenerateContentResponseBody4"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_ChatCompletionChunk

{
  "$ref": "#/components/schemas/Output_ChatCompletionChunk"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/conversations

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_conversation	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateConversationRequestBody

{
  "$ref": "#/components/schemas/Input_CreateConversationRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ConversationResponseBody

{
  "$ref": "#/components/schemas/Output_ConversationResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/decisions

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_decision	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateDecisionRequestBody

{
  "$ref": "#/components/schemas/Input_CreateDecisionRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CreateDecisionResponseBody

{
  "$ref": "#/components/schemas/Output_CreateDecisionResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/embeddings

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_embedding	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateEmbeddingRequestBody

{
  "$ref": "#/components/schemas/Input_CreateEmbeddingRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CreateEmbeddingResponseBody

{
  "$ref": "#/components/schemas/Output_CreateEmbeddingResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/files

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	list_files	HTTP
claude	list_files	HTTP

Parameters · Request body · Responses

Parameters

after (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

limit (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

order (query) — Required: No

Referenced structures: Input_FileOrder

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Input_FileOrder"
    },
    {
      "type": "null"
    }
  ]
}

purpose (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

after_id (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

before_id (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ids (query) — Required: No

{
  "items": {
    "type": "string"
  },
  "type": [
    "array",
    "null"
  ]
}

page (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

scope_id (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ListFilesResponseBody, Output_ListFilesResponseBody2

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_ListFilesResponseBody"
    },
    {
      "$ref": "#/components/schemas/Output_ListFilesResponseBody2"
    }
  ]
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/files

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_file	HTTP
claude	create_file	HTTP

Parameters · Request body · Responses

Request body

multipart/form-data

Referenced structures: Input_UploadFileForm, Input_UploadFileForm2

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Input_UploadFileForm"
    },
    {
      "$ref": "#/components/schemas/Input_UploadFileForm2"
    }
  ]
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_FileMetadata, Output_FileObject

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_FileObject"
    },
    {
      "$ref": "#/components/schemas/Output_FileMetadata"
    }
  ]
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

DELETE /v1/files/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	delete_file	HTTP
claude	delete_file	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_DeleteFileResponseBody, Output_DeleteFileResponseBody2

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_DeleteFileResponseBody"
    },
    {
      "$ref": "#/components/schemas/Output_DeleteFileResponseBody2"
    }
  ]
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/files/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	retrieve_file	HTTP
claude	retrieve_file	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_FileMetadata, Output_FileObject

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_FileObject"
    },
    {
      "$ref": "#/components/schemas/Output_FileMetadata"
    }
  ]
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/files/{id}/content

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	retrieve_file_content	HTTP
claude	retrieve_file_content	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/octet-stream

{
  "format": "binary",
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/images/edits

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	edit_image	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_EditImageJsonBody

{
  "$ref": "#/components/schemas/Input_EditImageJsonBody"
}

multipart/form-data

Referenced structures: Input_EditImageMultipartForm

{
  "$ref": "#/components/schemas/Input_EditImageMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ImagesResponse

{
  "$ref": "#/components/schemas/Output_ImagesResponse"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_ImageEditStreamEvent

{
  "$ref": "#/components/schemas/Output_ImageEditStreamEvent"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/images/generations

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_image	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateImageRequestBody

{
  "$ref": "#/components/schemas/Input_CreateImageRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ImagesResponse

{
  "$ref": "#/components/schemas/Output_ImagesResponse"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_ImageGenerationStreamEvent

{
  "$ref": "#/components/schemas/Output_ImageGenerationStreamEvent"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/live

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	connect_realtime	WebSocket

Parameters · Request body · Responses

Parameters

model (query) — Required: No

{
  "type": "string"
}

call_id (query) — Required: No

{
  "type": "string"
}

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_RealtimeClientEvent

{
  "$ref": "#/components/schemas/Input_RealtimeClientEvent"
}

Server message

Referenced structures: Output_RealtimeServerEvent

{
  "$ref": "#/components/schemas/Output_RealtimeServerEvent"
}

POST /v1/live

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_realtime_call	HTTP

Parameters · Request body · Responses

Request body

multipart/form-data

Referenced structures: Input_CreateLiveCallMultipartForm

{
  "$ref": "#/components/schemas/Input_CreateLiveCallMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/sdp

{
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/live/sessions

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	connect_live	WebSocket

Parameters · Request body · Responses

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_LiveClientEvent

{
  "$ref": "#/components/schemas/Input_LiveClientEvent"
}

Server message

Referenced structures: Output_LiveServerEvent

{
  "$ref": "#/components/schemas/Output_LiveServerEvent"
}

POST /v1/live/sessions

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_live_session	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateLiveSessionRequestBody

{
  "$ref": "#/components/schemas/Input_CreateLiveSessionRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CreateLiveSessionResponseBody

{
  "$ref": "#/components/schemas/Output_CreateLiveSessionResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/live/sessions/{session_id}/attach

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	connect_live	WebSocket

Parameters · Request body · Responses

Parameters

session_id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_LiveClientEvent

{
  "$ref": "#/components/schemas/Input_LiveClientEvent"
}

Server message

Referenced structures: Output_LiveServerEvent

{
  "$ref": "#/components/schemas/Output_LiveServerEvent"
}

POST /v1/live/sessions/{session_id}/hangup

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	hangup_live_session	HTTP

Parameters · Request body · Responses

Parameters

session_id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful response without a body

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/live/{call_id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	connect_realtime	WebSocket

Parameters · Request body · Responses

Parameters

call_id (path) — Required: Yes

{
  "type": "string"
}

model (query) — Required: No

{
  "type": "string"
}

call_id (query) — Required: No

{
  "type": "string"
}

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_RealtimeClientEvent

{
  "$ref": "#/components/schemas/Input_RealtimeClientEvent"
}

Server message

Referenced structures: Output_RealtimeServerEvent

{
  "$ref": "#/components/schemas/Output_RealtimeServerEvent"
}

POST /v1/messages

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
claude	generate_content stream: true → stream_generate_content	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_GenerateContentRequestBody2

{
  "$ref": "#/components/schemas/Input_GenerateContentRequestBody2"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_GenerateContentResponseBody2

{
  "$ref": "#/components/schemas/Output_GenerateContentResponseBody2"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_StreamEvent2

{
  "$ref": "#/components/schemas/Output_StreamEvent2"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/messages/count_tokens

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
claude	count_tokens	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CountTokensRequestBody2

{
  "$ref": "#/components/schemas/Input_CountTokensRequestBody2"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CountTokensResponseBody2

{
  "$ref": "#/components/schemas/Output_CountTokensResponseBody2"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/models

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	list_models	HTTP
claude	list_models	HTTP

Parameters · Request body · Responses

Parameters

after_id (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

before_id (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

limit (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ListModelsResponseBody, Output_ListModelsResponseBody2

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_ListModelsResponseBody"
    },
    {
      "$ref": "#/components/schemas/Output_ListModelsResponseBody2"
    }
  ]
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/models/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	get_model	HTTP
claude	get_model	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_Model, Output_ModelInfo

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Model"
    },
    {
      "$ref": "#/components/schemas/Output_ModelInfo"
    }
  ]
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/moderations

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_moderation	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateModerationRequestBody

{
  "$ref": "#/components/schemas/Input_CreateModerationRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CreateModerationResponseBody

{
  "$ref": "#/components/schemas/Output_CreateModerationResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/realtime

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	connect_realtime	WebSocket

Parameters · Request body · Responses

Parameters

model (query) — Required: No

{
  "type": "string"
}

call_id (query) — Required: No

{
  "type": "string"
}

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_RealtimeClientEvent

{
  "$ref": "#/components/schemas/Input_RealtimeClientEvent"
}

Server message

Referenced structures: Output_RealtimeServerEvent

{
  "$ref": "#/components/schemas/Output_RealtimeServerEvent"
}

POST /v1/realtime/calls

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_realtime_call	HTTP

Parameters · Request body · Responses

Request body

multipart/form-data

Referenced structures: Input_CreateRealtimeCallMultipartForm

{
  "$ref": "#/components/schemas/Input_CreateRealtimeCallMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/sdp

{
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/realtime/calls/{call_id}/hangup

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	hangup_realtime_call	HTTP

Parameters · Request body · Responses

Parameters

call_id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful response without a body

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/realtime/client_secrets

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_realtime_client_secret	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CreateRealtimeClientSecretRequestBody

{
  "$ref": "#/components/schemas/Input_CreateRealtimeClientSecretRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CreateRealtimeClientSecretResponseBody

{
  "$ref": "#/components/schemas/Output_CreateRealtimeClientSecretResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/rerank

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	rerank	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_RerankRequestBody

{
  "$ref": "#/components/schemas/Input_RerankRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_RerankResponseBody

{
  "$ref": "#/components/schemas/Output_RerankResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/responses

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai_responses_websocket	generate_content	WebSocket

Parameters · Request body · Responses

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_RequestMessage

{
  "$ref": "#/components/schemas/Input_RequestMessage"
}

Server message

Referenced structures: Output_ErrorMessage, Output_ServerMessage

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_ServerMessage"
    },
    {
      "$ref": "#/components/schemas/Output_ErrorMessage"
    }
  ]
}

POST /v1/responses

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	generate_content stream: true → stream_generate_content	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_GenerateContentRequestBody

{
  "$ref": "#/components/schemas/Input_GenerateContentRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_GenerateContentResponseBody

{
  "$ref": "#/components/schemas/Output_GenerateContentResponseBody"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_StreamEvent

{
  "$ref": "#/components/schemas/Output_StreamEvent"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/responses/compact

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	compact_content	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CompactRequestBody

{
  "$ref": "#/components/schemas/Input_CompactRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CompactResponseBody

{
  "$ref": "#/components/schemas/Output_CompactResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/responses/input_tokens

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	count_tokens	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_CountTokensRequestBody

{
  "$ref": "#/components/schemas/Input_CountTokensRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CountTokensResponseBody

{
  "$ref": "#/components/schemas/Output_CountTokensResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/search

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	web_search	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_WebSearchRequestBody

{
  "$ref": "#/components/schemas/Input_WebSearchRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_WebSearchResponseBody

{
  "$ref": "#/components/schemas/Output_WebSearchResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/videos

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	list_videos	HTTP

Parameters · Request body · Responses

Parameters

after (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

limit (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

order (query) — Required: No

Referenced structures: Input_NativeVideoListOrder

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Input_NativeVideoListOrder"
    },
    {
      "type": "null"
    }
  ]
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_NativeListVideosResponseBody

{
  "$ref": "#/components/schemas/Output_NativeListVideosResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1/videos

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	create_video	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_NativeCreateVideoRequestBody

{
  "$ref": "#/components/schemas/Input_NativeCreateVideoRequestBody"
}

multipart/form-data

Referenced structures: Input_NativeCreateVideoMultipartForm

{
  "$ref": "#/components/schemas/Input_NativeCreateVideoMultipartForm"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_NativeVideo

{
  "$ref": "#/components/schemas/Output_NativeVideo"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

DELETE /v1/videos/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	delete_video	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_NativeDeleteVideoResponseBody

{
  "$ref": "#/components/schemas/Output_NativeDeleteVideoResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/videos/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	retrieve_video	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_NativeVideo

{
  "$ref": "#/components/schemas/Output_NativeVideo"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1/videos/{id}/content

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
openai	download_video_content	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

variant (query) — Required: No

Referenced structures: Input_NativeVideoDownloadVariant

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Input_NativeVideoDownloadVariant"
    },
    {
      "type": "null"
    }
  ]
}

Responses

Status: 2XX — Successful protocol response

application/octet-stream

{
  "format": "binary",
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1beta/files

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	list_files	HTTP

Parameters · Request body · Responses

Parameters

pageSize (query) — Required: No

{
  "format": "int32",
  "type": [
    "integer",
    "null"
  ]
}

pageToken (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ListFilesResponseBody3

{
  "$ref": "#/components/schemas/Output_ListFilesResponseBody3"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1beta/files

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	create_file	HTTP

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_UploadFileMetadata

{
  "$ref": "#/components/schemas/Input_UploadFileMetadata"
}

application/octet-stream

{
  "format": "binary",
  "type": "string"
}

multipart/related

Referenced structures: Input_UploadFileForm3

{
  "$ref": "#/components/schemas/Input_UploadFileForm3"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_UploadFileResponseBody

{
  "$ref": "#/components/schemas/Output_UploadFileResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

DELETE /v1beta/files/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	delete_file	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_DeleteFileResponseBody3

{
  "$ref": "#/components/schemas/Output_DeleteFileResponseBody3"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1beta/files/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	retrieve_file	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_File

{
  "$ref": "#/components/schemas/Output_File"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1beta/files/{id}:download

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	retrieve_file_content	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/octet-stream

{
  "format": "binary",
  "type": "string"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1beta/models

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	list_models	HTTP

Parameters · Request body · Responses

Parameters

pageSize (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

pageToken (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_ListModelsResponseBody3

{
  "$ref": "#/components/schemas/Output_ListModelsResponseBody3"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /v1beta/models/{id}

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	get_model	HTTP

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_Model2

{
  "$ref": "#/components/schemas/Output_Model2"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1beta/models/{model}:batchEmbedContents

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	batch_create_embedding	HTTP

Parameters · Request body · Responses

Parameters

model (path) — Required: Yes

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchEmbedContentsRequestBody

{
  "$ref": "#/components/schemas/Input_BatchEmbedContentsRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_BatchEmbedContentsResponseBody

{
  "$ref": "#/components/schemas/Output_BatchEmbedContentsResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1beta/models/{model}:countTokens

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	count_tokens	HTTP

Parameters · Request body · Responses

Parameters

model (path) — Required: Yes

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_CountTokensRequestBody3

{
  "$ref": "#/components/schemas/Input_CountTokensRequestBody3"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_CountTokensResponseBody3

{
  "$ref": "#/components/schemas/Output_CountTokensResponseBody3"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1beta/models/{model}:embedContent

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	create_embedding	HTTP

Parameters · Request body · Responses

Parameters

model (path) — Required: Yes

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_EmbedContentRequestBody

{
  "$ref": "#/components/schemas/Input_EmbedContentRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_EmbedContentResponseBody

{
  "$ref": "#/components/schemas/Output_EmbedContentResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1beta/models/{model}:generateContent

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	generate_content	HTTP

Parameters · Request body · Responses

Parameters

model (path) — Required: Yes

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_GenerateContentRequestBody3

{
  "$ref": "#/components/schemas/Input_GenerateContentRequestBody3"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_GenerateContentResponseBody3

{
  "$ref": "#/components/schemas/Output_GenerateContentResponseBody3"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

POST /v1beta/models/{model}:streamGenerateContent

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	stream_generate_content	HTTP

Parameters · Request body · Responses

Parameters

model (path) — Required: Yes

{
  "type": "string"
}

alt (query) — Required: No

{
  "enum": [
    "sse",
    "json"
  ],
  "type": "string"
}

Request body

application/json

Referenced structures: Input_GenerateContentRequestBody3

{
  "$ref": "#/components/schemas/Input_GenerateContentRequestBody3"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_GenerateContentResponseBody3

{
  "items": {
    "$ref": "#/components/schemas/Output_GenerateContentResponseBody3"
  },
  "type": "array"
}

text/event-stream

{
  "type": "string"
}

Stream event

Referenced structures: Output_GenerateContentResponseBody3

{
  "$ref": "#/components/schemas/Output_GenerateContentResponseBody3"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

GET /ws/v1beta/BidiGenerateContent

Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.

Dialect	Operation	Transport
gemini	connect_realtime	WebSocket

Parameters · Request body · Responses

Responses

Status: 101 — WebSocket upgrade

No body

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

WebSocket messages

Client message

Referenced structures: Input_LiveClientMessage

{
  "$ref": "#/components/schemas/Input_LiveClientMessage"
}

Server message

Referenced structures: Output_LiveServerMessage

{
  "$ref": "#/components/schemas/Output_LiveServerMessage"
}

Codex provider

POST /{provider}/v1/memories/trace_summarize

Only available on a Codex provider mount. The provider parameter is the configured provider name.

Dialect	Operation	Transport
openai	summarize_memory	HTTP

Parameters · Request body · Responses

Parameters

provider (path) — Required: Yes

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_MemorySummarizeRequestBody

{
  "$ref": "#/components/schemas/Input_MemorySummarizeRequestBody"
}

Responses

Status: 2XX — Successful protocol response

application/json

Referenced structures: Output_MemorySummarizeResponseBody

{
  "$ref": "#/components/schemas/Output_MemorySummarizeResponseBody"
}

Status: default — Gateway or upstream error

application/json

Referenced structures: Output_Envelope, Output_ErrorDetail, Output_ErrorEvent, Output_GenerateContentError

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_Envelope"
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_ErrorDetail"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    },
    {
      "allOf": [
        {
          "$ref": "#/components/schemas/Output_ErrorEvent"
        },
        {
          "properties": {
            "type": {
              "const": "error"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        }
      ]
    },
    {
      "properties": {
        "error": {
          "$ref": "#/components/schemas/Output_GenerateContentError"
        }
      },
      "required": [
        "error"
      ],
      "type": "object"
    }
  ]
}

text/plain

{
  "type": "string"
}

Management

GET /admin/api/api-keys

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page2

{
  "$ref": "#/components/schemas/Output_Page2"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/api-keys

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ApiKeyWrite

{
  "$ref": "#/components/schemas/Input_ApiKeyWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApiKeyCreated

{
  "$ref": "#/components/schemas/Output_ApiKeyCreated"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/api-keys/batch

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem2

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem2"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApiKeyDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_ApiKeyDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/api-keys/{id}

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/api-keys/{id}

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApiKeyDto

{
  "$ref": "#/components/schemas/Output_ApiKeyDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/api-keys/{id}

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ApiKeyPatch

{
  "$ref": "#/components/schemas/Input_ApiKeyPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApiKeyDto

{
  "$ref": "#/components/schemas/Output_ApiKeyDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/api-keys/{id}/rotate

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApiKeyCreated

{
  "$ref": "#/components/schemas/Output_ApiKeyCreated"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/api-keys/{id}/secret

Administrative section: api-keys

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApiKeySecretDto

{
  "$ref": "#/components/schemas/Output_ApiKeySecretDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/audit

Administrative section: audit

Parameters · Request body · Responses

Parameters

action (query) — Required: No

Case-insensitive substring, so `users.` selects a whole family.

{
  "description": "Case-insensitive substring, so `users.` selects a whole family.",
  "type": [
    "string",
    "null"
  ]
}

actorApiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

actorUserId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

entityId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

entityKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

outcome (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based; zero and absent both mean the first page.

{
  "description": "1-based; zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

sinceMs (query) — Required: No

Inclusive lower bound on `createdAtMs`.

{
  "description": "Inclusive lower bound on `createdAtMs`.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

untilMs (query) — Required: No

Exclusive upper bound on `createdAtMs`.

{
  "description": "Exclusive upper bound on `createdAtMs`.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page11

{
  "$ref": "#/components/schemas/Output_Page11"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/channels

Administrative section: catalog

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ChannelDescriptor

{
  "items": {
    "$ref": "#/components/schemas/Output_ChannelDescriptor"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/connection-profiles

Administrative section: connection-profiles

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page18

{
  "$ref": "#/components/schemas/Output_Page18"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/connection-profiles

Administrative section: connection-profiles

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ConnectionProfileWrite

{
  "$ref": "#/components/schemas/Input_ConnectionProfileWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ConnectionProfileDto

{
  "$ref": "#/components/schemas/Output_ConnectionProfileDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/connection-profiles/batch

Administrative section: connection-profiles

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem14

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem14"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ConnectionProfileDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_ConnectionProfileDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/connection-profiles/{id}

Administrative section: connection-profiles

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/connection-profiles/{id}

Administrative section: connection-profiles

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ConnectionProfileDto

{
  "$ref": "#/components/schemas/Output_ConnectionProfileDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/connection-profiles/{id}

Administrative section: connection-profiles

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ConnectionProfilePatch

{
  "$ref": "#/components/schemas/Input_ConnectionProfilePatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ConnectionProfileDto

{
  "$ref": "#/components/schemas/Output_ConnectionProfileDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/connectivity/test

Administrative section: connectivity

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ConnectivityTest

{
  "$ref": "#/components/schemas/Input_ConnectivityTest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ConnectivityResultDto

{
  "$ref": "#/components/schemas/Output_ConnectivityResultDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/context

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AdminContextDto

{
  "$ref": "#/components/schemas/Output_AdminContextDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credential-login/authcode/complete

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_AuthCodeComplete

{
  "$ref": "#/components/schemas/Input_AuthCodeComplete"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialCreated

{
  "$ref": "#/components/schemas/Output_CredentialCreated"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credential-login/authcode/start

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_AuthCodeStart

{
  "$ref": "#/components/schemas/Input_AuthCodeStart"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthCodeStarted

{
  "$ref": "#/components/schemas/Output_AuthCodeStarted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credential-login/device/poll

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_Poll

{
  "$ref": "#/components/schemas/Input_Poll"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DevicePollOutcome

{
  "$ref": "#/components/schemas/Output_DevicePollOutcome"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credential-login/device/start

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_DeviceStart

{
  "$ref": "#/components/schemas/Input_DeviceStart"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DeviceStarted

{
  "$ref": "#/components/schemas/Output_DeviceStarted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials

Administrative section: credentials

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page13

{
  "$ref": "#/components/schemas/Output_Page13"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_CredentialWrite

{
  "$ref": "#/components/schemas/Input_CredentialWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialDto

{
  "$ref": "#/components/schemas/Output_CredentialDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/batch

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem9

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem9"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_CredentialDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/owners

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialOwnerOptionDto

{
  "items": {
    "$ref": "#/components/schemas/Output_CredentialOwnerOptionDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/providers

Administrative section: credentials

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialProviderDto

{
  "items": {
    "$ref": "#/components/schemas/Output_CredentialProviderDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/credentials/{id}

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/{id}

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialDto

{
  "$ref": "#/components/schemas/Output_CredentialDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/credentials/{id}

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_CredentialPatch

{
  "$ref": "#/components/schemas/Input_CredentialPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialDto

{
  "$ref": "#/components/schemas/Output_CredentialDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/health-reset

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialDto

{
  "$ref": "#/components/schemas/Output_CredentialDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/{id}/limits

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialLimitStatusDto

{
  "items": {
    "$ref": "#/components/schemas/Output_CredentialLimitStatusDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/models/discover

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DiscoveredModelDto

{
  "items": {
    "$ref": "#/components/schemas/Output_DiscoveredModelDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/models/test

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_Model

{
  "$ref": "#/components/schemas/Input_Model"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ModelTestResultDto

{
  "$ref": "#/components/schemas/Output_ModelTestResultDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/{id}/quota

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialQuotaDto

{
  "$ref": "#/components/schemas/Output_CredentialQuotaDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/quota-diagnostics

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaProbeDto

{
  "$ref": "#/components/schemas/Output_QuotaProbeDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/{id}/quota-observations

Administrative section: credentials

Parameters · Request body · Responses

Parameters

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

sinceMs (query) — Required: No

Inclusive. Absent means the start of the earliest open cycle of the credential, or 24 hours before now when none is open.

{
  "description": "Inclusive. Absent means the start of the earliest open cycle of the\ncredential, or 24 hours before now when none is open.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

untilMs (query) — Required: No

Exclusive. Absent means no upper bound.

{
  "description": "Exclusive. Absent means no upper bound.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page28

{
  "$ref": "#/components/schemas/Output_Page28"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/quota-probe

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaSnapshotDto

{
  "$ref": "#/components/schemas/Output_QuotaSnapshotDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/quota-reset

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

Optional request body

application/json

Referenced structures: Input_QuotaResetWrite

{
  "$ref": "#/components/schemas/Input_QuotaResetWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaResetDto

{
  "$ref": "#/components/schemas/Output_QuotaResetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/credentials/{id}/quota-reset-credits

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaResetCreditsDto

{
  "$ref": "#/components/schemas/Output_QuotaResetCreditsDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/refresh

Administrative section: credentials

Parameters · Request body · Responses

Parameters

force (query) — Required: No

{
  "default": false,
  "type": "boolean"
}

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialSummaryDto

{
  "$ref": "#/components/schemas/Output_CredentialSummaryDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/reveal

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

true

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/credentials/{id}/status

Administrative section: credentials

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_StatusBody

{
  "$ref": "#/components/schemas/Input_StatusBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CredentialDto

{
  "$ref": "#/components/schemas/Output_CredentialDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/default-model-catalog

Administrative section: catalog

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DefaultModelCatalogDto

{
  "$ref": "#/components/schemas/Output_DefaultModelCatalogDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/default-model-catalog/apply-prices

Administrative section: catalog

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ApplyDefaultPricesRequest

{
  "$ref": "#/components/schemas/Input_ApplyDefaultPricesRequest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ApplyDefaultPricesReportDto

{
  "$ref": "#/components/schemas/Output_ApplyDefaultPricesReportDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/export

Administrative section: transfer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ExportRequest

{
  "$ref": "#/components/schemas/Input_ExportRequest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ConfigurationExportDto

{
  "$ref": "#/components/schemas/Output_ConfigurationExportDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/fonts

Availability: Native host with the console enabled

Administrative section: configuration.settings

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_FontStatus

{
  "$ref": "#/components/schemas/Output_FontStatus"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/fonts

Availability: Native host with the console enabled

Administrative section: configuration.settings

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_FontStatus

{
  "$ref": "#/components/schemas/Output_FontStatus"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/fonts

Availability: Native host with the console enabled

Administrative section: configuration.settings

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_FontStatus

{
  "$ref": "#/components/schemas/Output_FontStatus"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/import

Administrative section: transfer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ImportRequest

{
  "$ref": "#/components/schemas/Input_ImportRequest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ImportReportDto

{
  "$ref": "#/components/schemas/Output_ImportReportDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/logs/captures/{id}

Administrative section: logs

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_CaptureDetailDto

{
  "$ref": "#/components/schemas/Output_CaptureDetailDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/logs/downstream

Administrative section: logs

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_HistoryDeleted

{
  "$ref": "#/components/schemas/Output_HistoryDeleted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/logs/downstream

Administrative section: logs

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

cursor (query) — Required: No

`next_cursor` of the previous page.

{
  "description": "`next_cursor` of the previous page.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

cursorId (query) — Required: No

`next_cursor_id` of the previous page. Without it a cursor is only a timestamp, and records sharing a millisecond would repeat.

{
  "description": "`next_cursor_id` of the previous page. Without it a cursor is only a\ntimestamp, and records sharing a millisecond would repeat.",
  "type": [
    "string",
    "null"
  ]
}

fromMs (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

limit (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

model (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

operation (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

reason (query) — Required: No

Exact normalized upstream reason (for example `refusal`).

{
  "description": "Exact normalized upstream reason (for example `refusal`).",
  "type": [
    "string",
    "null"
  ]
}

requestId (query) — Required: No

One request by id, which for a downstream record is its own id.

{
  "description": "One request by id, which for a downstream record is its own id.",
  "type": [
    "string",
    "null"
  ]
}

status (query) — Required: No

Exact HTTP response status.

{
  "description": "Exact HTTP response status.",
  "format": "int32",
  "type": [
    "integer",
    "null"
  ]
}

toMs (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_LogPageDto

{
  "$ref": "#/components/schemas/Output_LogPageDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/logs/downstream/delete

Administrative section: logs

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_HistoryDelete

{
  "$ref": "#/components/schemas/Input_HistoryDelete"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_HistoryDeleted

{
  "$ref": "#/components/schemas/Output_HistoryDeleted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/logs/downstream/{id}

Administrative section: logs

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_LogDetailDto

{
  "$ref": "#/components/schemas/Output_LogDetailDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/logs/upstream

Administrative section: logs

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_HistoryDeleted

{
  "$ref": "#/components/schemas/Output_HistoryDeleted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/logs/upstream

Administrative section: logs

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

cursor (query) — Required: No

`next_cursor` of the previous page.

{
  "description": "`next_cursor` of the previous page.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

cursorId (query) — Required: No

`next_cursor_id` of the previous page. Without it a cursor is only a timestamp, and records sharing a millisecond would repeat.

{
  "description": "`next_cursor_id` of the previous page. Without it a cursor is only a\ntimestamp, and records sharing a millisecond would repeat.",
  "type": [
    "string",
    "null"
  ]
}

fromMs (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

limit (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

model (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

operation (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

reason (query) — Required: No

Exact normalized upstream reason (for example `refusal`).

{
  "description": "Exact normalized upstream reason (for example `refusal`).",
  "type": [
    "string",
    "null"
  ]
}

requestId (query) — Required: No

One request by id, which for a downstream record is its own id.

{
  "description": "One request by id, which for a downstream record is its own id.",
  "type": [
    "string",
    "null"
  ]
}

status (query) — Required: No

Exact HTTP response status.

{
  "description": "Exact HTTP response status.",
  "format": "int32",
  "type": [
    "integer",
    "null"
  ]
}

toMs (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_LogPageDto

{
  "$ref": "#/components/schemas/Output_LogPageDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/logs/upstream/delete

Administrative section: logs

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_HistoryDelete

{
  "$ref": "#/components/schemas/Input_HistoryDelete"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_HistoryDeleted

{
  "$ref": "#/components/schemas/Output_HistoryDeleted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/model-names

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page29

{
  "$ref": "#/components/schemas/Output_Page29"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/models

Administrative section: models

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page14

{
  "$ref": "#/components/schemas/Output_Page14"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/models

Administrative section: models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ModelWrite

{
  "$ref": "#/components/schemas/Input_ModelWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ModelDto

{
  "$ref": "#/components/schemas/Output_ModelDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/models/batch

Administrative section: models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem10

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem10"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ModelDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_ModelDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/models/discover

Administrative section: models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_DiscoverBody

{
  "$ref": "#/components/schemas/Input_DiscoverBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DiscoveredModelDto

{
  "items": {
    "$ref": "#/components/schemas/Output_DiscoveredModelDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/models/discover/apply

Administrative section: models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ApplyDiscoveredBody

{
  "$ref": "#/components/schemas/Input_ApplyDiscoveredBody"
}

Responses

Status: 200 — Success

application/json

{
  "items": {
    "type": "string"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/models/test

Administrative section: models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ModelTest

{
  "$ref": "#/components/schemas/Input_ModelTest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ModelTestResultDto

{
  "$ref": "#/components/schemas/Output_ModelTestResultDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/models/{id}

Administrative section: models

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/models/{id}

Administrative section: models

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ModelDto

{
  "$ref": "#/components/schemas/Output_ModelDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/models/{id}

Administrative section: models

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ModelPatch

{
  "$ref": "#/components/schemas/Input_ModelPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ModelDto

{
  "$ref": "#/components/schemas/Output_ModelDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/oauth-clients

Administrative section: oauth-clients

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page7

{
  "$ref": "#/components/schemas/Output_Page7"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/oauth-clients

Administrative section: oauth-clients

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OAuthClientWrite

{
  "$ref": "#/components/schemas/Input_OAuthClientWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OAuthClientDto

{
  "$ref": "#/components/schemas/Output_OAuthClientDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/oauth-clients/batch

Administrative section: oauth-clients

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem7

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem7"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OAuthClientDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_OAuthClientDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/oauth-clients/{id}

Administrative section: oauth-clients

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OAuthClientDto

{
  "$ref": "#/components/schemas/Output_OAuthClientDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/oauth-clients/{id}

Administrative section: oauth-clients

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OAuthClientPatch

{
  "$ref": "#/components/schemas/Input_OAuthClientPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OAuthClientDto

{
  "$ref": "#/components/schemas/Output_OAuthClientDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/oauth-clients/{id}/retire

Administrative section: oauth-clients

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OAuthClientDto

{
  "$ref": "#/components/schemas/Output_OAuthClientDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/operation-endpoints

Administrative section: operation-endpoints

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page23

{
  "$ref": "#/components/schemas/Output_Page23"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/operation-endpoints

Administrative section: operation-endpoints

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OperationEndpointWrite

{
  "$ref": "#/components/schemas/Input_OperationEndpointWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationEndpointDto

{
  "$ref": "#/components/schemas/Output_OperationEndpointDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/operation-endpoints/batch

Administrative section: operation-endpoints

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem19

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem19"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationEndpointDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_OperationEndpointDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/operation-endpoints/{id}

Administrative section: operation-endpoints

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/operation-endpoints/{id}

Administrative section: operation-endpoints

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationEndpointDto

{
  "$ref": "#/components/schemas/Output_OperationEndpointDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/operation-endpoints/{id}

Administrative section: operation-endpoints

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OperationEndpointPatch

{
  "$ref": "#/components/schemas/Input_OperationEndpointPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationEndpointDto

{
  "$ref": "#/components/schemas/Output_OperationEndpointDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/operation-keys

Administrative section: catalog

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RoutingTargetDto

{
  "items": {
    "$ref": "#/components/schemas/Output_RoutingTargetDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/operation-rules

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page22

{
  "$ref": "#/components/schemas/Output_Page22"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/operation-rules

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OperationRuleWrite

{
  "$ref": "#/components/schemas/Input_OperationRuleWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRuleDto

{
  "$ref": "#/components/schemas/Output_OperationRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/operation-rules/batch

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem18

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem18"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRuleDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_OperationRuleDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/operation-rules/{id}

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/operation-rules/{id}

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRuleDto

{
  "$ref": "#/components/schemas/Output_OperationRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/operation-rules/{id}

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OperationRulePatch

{
  "$ref": "#/components/schemas/Input_OperationRulePatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRuleDto

{
  "$ref": "#/components/schemas/Output_OperationRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/organizations

Administrative section: organizations

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page3

{
  "$ref": "#/components/schemas/Output_Page3"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/organizations

Administrative section: organizations

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OrganizationWrite

{
  "$ref": "#/components/schemas/Input_OrganizationWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationDto

{
  "$ref": "#/components/schemas/Output_OrganizationDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/organizations/batch

Administrative section: organizations

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem3

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem3"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_OrganizationDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/organizations/{id}

Administrative section: organizations

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/organizations/{id}

Administrative section: organizations

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationDto

{
  "$ref": "#/components/schemas/Output_OrganizationDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/organizations/{id}

Administrative section: organizations

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_OrganizationPatch

{
  "$ref": "#/components/schemas/Input_OrganizationPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationDto

{
  "$ref": "#/components/schemas/Output_OrganizationDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/organizations/{id}/members

Administrative section: members

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page8

{
  "$ref": "#/components/schemas/Output_Page8"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/organizations/{id}/members

Administrative section: members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_MemberWrite

{
  "$ref": "#/components/schemas/Input_MemberWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationMemberDto

{
  "$ref": "#/components/schemas/Output_OrganizationMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/organizations/{id}/members/{user_id}

Administrative section: members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

user_id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/organizations/{id}/members/{user_id}

Administrative section: members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

user_id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationMemberDto

{
  "$ref": "#/components/schemas/Output_OrganizationMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PUT /admin/api/organizations/{id}/members/{user_id}

Administrative section: members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

user_id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_MemberPatch

{
  "$ref": "#/components/schemas/Input_MemberPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OrganizationMemberDto

{
  "$ref": "#/components/schemas/Output_OrganizationMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/permissions

Administrative section: permissions

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page5

{
  "$ref": "#/components/schemas/Output_Page5"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/permissions

Administrative section: permissions

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PermissionWrite

{
  "$ref": "#/components/schemas/Input_PermissionWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PermissionDto

{
  "$ref": "#/components/schemas/Output_PermissionDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/permissions/batch

Administrative section: permissions

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem5

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem5"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PermissionDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_PermissionDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/permissions/{id}

Administrative section: permissions

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/permissions/{id}

Administrative section: permissions

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PermissionDto

{
  "$ref": "#/components/schemas/Output_PermissionDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/permissions/{id}

Administrative section: permissions

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PermissionPatch

{
  "$ref": "#/components/schemas/Input_PermissionPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PermissionDto

{
  "$ref": "#/components/schemas/Output_PermissionDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/price-rates

Administrative section: price-rates

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page26

{
  "$ref": "#/components/schemas/Output_Page26"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/price-rates

Administrative section: price-rates

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PriceRateWrite

{
  "$ref": "#/components/schemas/Input_PriceRateWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRateDto

{
  "$ref": "#/components/schemas/Output_PriceRateDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/price-rates/batch

Administrative section: price-rates

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem22

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem22"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRateDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_PriceRateDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/price-rates/{id}

Administrative section: price-rates

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/price-rates/{id}

Administrative section: price-rates

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRateDto

{
  "$ref": "#/components/schemas/Output_PriceRateDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/price-rates/{id}

Administrative section: price-rates

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PriceRatePatch

{
  "$ref": "#/components/schemas/Input_PriceRatePatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRateDto

{
  "$ref": "#/components/schemas/Output_PriceRateDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/price-rules

Administrative section: price-rules

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page25

{
  "$ref": "#/components/schemas/Output_Page25"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/price-rules

Administrative section: price-rules

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PriceRuleWrite

{
  "$ref": "#/components/schemas/Input_PriceRuleWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRuleDto

{
  "$ref": "#/components/schemas/Output_PriceRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/price-rules/batch

Administrative section: price-rules

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem21

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem21"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRuleDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_PriceRuleDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/price-rules/{id}

Administrative section: price-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/price-rules/{id}

Administrative section: price-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRuleDto

{
  "$ref": "#/components/schemas/Output_PriceRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/price-rules/{id}

Administrative section: price-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PriceRulePatch

{
  "$ref": "#/components/schemas/Input_PriceRulePatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceRuleDto

{
  "$ref": "#/components/schemas/Output_PriceRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/price-tiers

Administrative section: price-tiers

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page27

{
  "$ref": "#/components/schemas/Output_Page27"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/price-tiers

Administrative section: price-tiers

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PriceTierWrite

{
  "$ref": "#/components/schemas/Input_PriceTierWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceTierDto

{
  "$ref": "#/components/schemas/Output_PriceTierDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/price-tiers/batch

Administrative section: price-tiers

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem23

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem23"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceTierDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_PriceTierDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/price-tiers/{id}

Administrative section: price-tiers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/price-tiers/{id}

Administrative section: price-tiers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceTierDto

{
  "$ref": "#/components/schemas/Output_PriceTierDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/price-tiers/{id}

Administrative section: price-tiers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PriceTierPatch

{
  "$ref": "#/components/schemas/Input_PriceTierPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PriceTierDto

{
  "$ref": "#/components/schemas/Output_PriceTierDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/provider-models

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page15

{
  "$ref": "#/components/schemas/Output_Page15"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/provider-models

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ProviderModelWrite

{
  "$ref": "#/components/schemas/Input_ProviderModelWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderModelDto

{
  "$ref": "#/components/schemas/Output_ProviderModelDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/provider-models/batch

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem11

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem11"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderModelDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_ProviderModelDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/provider-models/{id}

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/provider-models/{id}

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderModelDto

{
  "$ref": "#/components/schemas/Output_ProviderModelDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/provider-models/{id}

Administrative section: provider-models

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ProviderModelPatch

{
  "$ref": "#/components/schemas/Input_ProviderModelPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderModelDto

{
  "$ref": "#/components/schemas/Output_ProviderModelDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/provider-rule-sets

Administrative section: provider-rule-sets

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page21

{
  "$ref": "#/components/schemas/Output_Page21"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/provider-rule-sets

Administrative section: provider-rule-sets

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ProviderRuleSetWrite

{
  "$ref": "#/components/schemas/Input_ProviderRuleSetWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderRuleSetDto

{
  "$ref": "#/components/schemas/Output_ProviderRuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/provider-rule-sets/batch

Administrative section: provider-rule-sets

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem17

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem17"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderRuleSetDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_ProviderRuleSetDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/provider-rule-sets/{id}

Administrative section: provider-rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/provider-rule-sets/{id}

Administrative section: provider-rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderRuleSetDto

{
  "$ref": "#/components/schemas/Output_ProviderRuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/provider-rule-sets/{id}

Administrative section: provider-rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ProviderRuleSetPatch

{
  "$ref": "#/components/schemas/Input_ProviderRuleSetPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderRuleSetDto

{
  "$ref": "#/components/schemas/Output_ProviderRuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/providers

Administrative section: providers

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page12

{
  "$ref": "#/components/schemas/Output_Page12"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/providers

Administrative section: providers

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ProviderWrite

{
  "$ref": "#/components/schemas/Input_ProviderWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderDto

{
  "$ref": "#/components/schemas/Output_ProviderDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/providers/batch

Administrative section: providers

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem8

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem8"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_ProviderDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/providers/{id}

Administrative section: providers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/providers/{id}

Administrative section: providers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderDto

{
  "$ref": "#/components/schemas/Output_ProviderDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/providers/{id}

Administrative section: providers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_ProviderPatch

{
  "$ref": "#/components/schemas/Input_ProviderPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_ProviderDto

{
  "$ref": "#/components/schemas/Output_ProviderDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/providers/{id}/default-rule-set

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RuleSetDto

{
  "$ref": "#/components/schemas/Output_RuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/providers/{id}/routing

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRoutingDto

{
  "items": {
    "$ref": "#/components/schemas/Output_OperationRoutingDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/providers/{id}/routing-defaults/reset

Administrative section: providers

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "cleared": {
      "type": "integer"
    }
  },
  "required": [
    "cleared"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/providers/{id}/routing/{operation}/{dialect}

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

operation (path) — Required: Yes

{
  "type": "string"
}

dialect (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRoutingDto

{
  "items": {
    "$ref": "#/components/schemas/Output_OperationRoutingDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PUT /admin/api/providers/{id}/routing/{operation}/{dialect}

Administrative section: operation-rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

operation (path) — Required: Yes

{
  "type": "string"
}

dialect (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RoutingMappingWrite

{
  "$ref": "#/components/schemas/Input_RoutingMappingWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_OperationRoutingDto

{
  "items": {
    "$ref": "#/components/schemas/Output_OperationRoutingDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/quotas

Administrative section: quotas

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page24

{
  "$ref": "#/components/schemas/Output_Page24"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/quotas

Administrative section: quotas

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_QuotaWrite

{
  "$ref": "#/components/schemas/Input_QuotaWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaDto

{
  "$ref": "#/components/schemas/Output_QuotaDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/quotas/batch

Administrative section: quotas

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem20

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem20"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_QuotaDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/quotas/status

Administrative section: quotas

Parameters · Request body · Responses

Parameters

owners (query) — Required: No

{
  "default": "",
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_BudgetStatusDto

{
  "items": {
    "$ref": "#/components/schemas/Output_BudgetStatusDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/quotas/{id}

Administrative section: quotas

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/quotas/{id}

Administrative section: quotas

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaDto

{
  "$ref": "#/components/schemas/Output_QuotaDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/quotas/{id}

Administrative section: quotas

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_QuotaPatch

{
  "$ref": "#/components/schemas/Input_QuotaPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_QuotaDto

{
  "$ref": "#/components/schemas/Output_QuotaDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/quotas/{id}/limit-reset

Administrative section: quotas

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

{
  "items": {
    "type": "string"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/quotas/{id}/reset

Administrative section: quotas

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_BudgetStatusDto

{
  "$ref": "#/components/schemas/Output_BudgetStatusDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rate-limits

Administrative section: rate-limits

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page6

{
  "$ref": "#/components/schemas/Output_Page6"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rate-limits

Administrative section: rate-limits

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RateLimitWrite

{
  "$ref": "#/components/schemas/Input_RateLimitWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RateLimitDto

{
  "$ref": "#/components/schemas/Output_RateLimitDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rate-limits/batch

Administrative section: rate-limits

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem6

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem6"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RateLimitDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_RateLimitDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/rate-limits/{id}

Administrative section: rate-limits

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rate-limits/{id}

Administrative section: rate-limits

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RateLimitDto

{
  "$ref": "#/components/schemas/Output_RateLimitDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/rate-limits/{id}

Administrative section: rate-limits

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RateLimitPatch

{
  "$ref": "#/components/schemas/Input_RateLimitPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RateLimitDto

{
  "$ref": "#/components/schemas/Output_RateLimitDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/route-members

Administrative section: route-members

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page17

{
  "$ref": "#/components/schemas/Output_Page17"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/route-members

Administrative section: route-members

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RouteMemberWrite

{
  "$ref": "#/components/schemas/Input_RouteMemberWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteMemberDto

{
  "$ref": "#/components/schemas/Output_RouteMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/route-members/batch

Administrative section: route-members

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem13

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem13"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteMemberDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_RouteMemberDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/route-members/{id}

Administrative section: route-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/route-members/{id}

Administrative section: route-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteMemberDto

{
  "$ref": "#/components/schemas/Output_RouteMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/route-members/{id}

Administrative section: route-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RouteMemberPatch

{
  "$ref": "#/components/schemas/Input_RouteMemberPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteMemberDto

{
  "$ref": "#/components/schemas/Output_RouteMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/routes

Administrative section: routes

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page16

{
  "$ref": "#/components/schemas/Output_Page16"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/routes

Administrative section: routes

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RouteWrite

{
  "$ref": "#/components/schemas/Input_RouteWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteDto

{
  "$ref": "#/components/schemas/Output_RouteDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/routes/batch

Administrative section: routes

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem12

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem12"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_RouteDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/routes/{id}

Administrative section: routes

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/routes/{id}

Administrative section: routes

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteDto

{
  "$ref": "#/components/schemas/Output_RouteDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/routes/{id}

Administrative section: routes

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RoutePatch

{
  "$ref": "#/components/schemas/Input_RoutePatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RouteDto

{
  "$ref": "#/components/schemas/Output_RouteDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rule-presets

Administrative section: catalog

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RulePresetDto

{
  "items": {
    "$ref": "#/components/schemas/Output_RulePresetDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rule-sets

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page19

{
  "$ref": "#/components/schemas/Output_Page19"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rule-sets

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RuleSetWrite

{
  "$ref": "#/components/schemas/Input_RuleSetWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RuleSetDto

{
  "$ref": "#/components/schemas/Output_RuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rule-sets/batch

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem15

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem15"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RuleSetDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_RuleSetDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/rule-sets/{id}

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rule-sets/{id}

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RuleSetDto

{
  "$ref": "#/components/schemas/Output_RuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/rule-sets/{id}

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RuleSetPatch

{
  "$ref": "#/components/schemas/Input_RuleSetPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RuleSetDto

{
  "$ref": "#/components/schemas/Output_RuleSetDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rule-sets/{id}/rule-presets/{preset}

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

preset (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RewriteRuleDto

{
  "items": {
    "$ref": "#/components/schemas/Output_RewriteRuleDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PUT /admin/api/rule-sets/{id}/rules

Administrative section: rule-sets

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RewriteRuleWrite

{
  "items": {
    "$ref": "#/components/schemas/Input_RewriteRuleWrite"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RewriteRuleDto

{
  "items": {
    "$ref": "#/components/schemas/Output_RewriteRuleDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rules

Administrative section: rules

Parameters · Request body · Responses

Parameters

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

globalOnly (query) — Required: No

Restrict price rules to the global scope.

{
  "description": "Restrict price rules to the global scope.",
  "type": [
    "boolean",
    "null"
  ]
}

modelId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

modelPattern (query) — Required: No

Exact pricing pattern (not a runtime wildcard match).

{
  "description": "Exact pricing pattern (not a runtime wildcard match).",
  "type": [
    "string",
    "null"
  ]
}

ownerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerKind (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

priceRuleId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

routeId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ruleSetId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page20

{
  "$ref": "#/components/schemas/Output_Page20"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rules

Administrative section: rules

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RewriteRuleWrite

{
  "$ref": "#/components/schemas/Input_RewriteRuleWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RewriteRuleDto

{
  "$ref": "#/components/schemas/Output_RewriteRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/rules/batch

Administrative section: rules

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem16

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem16"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RewriteRuleDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_RewriteRuleDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/rules/{id}

Administrative section: rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/rules/{id}

Administrative section: rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RewriteRuleDto

{
  "$ref": "#/components/schemas/Output_RewriteRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/rules/{id}

Administrative section: rules

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_RewriteRulePatch

{
  "$ref": "#/components/schemas/Input_RewriteRulePatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_RewriteRuleDto

{
  "$ref": "#/components/schemas/Output_RewriteRuleDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/session

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "endedSession": {
      "type": "boolean"
    }
  },
  "required": [
    "endedSession"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/session

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_SessionStatus

{
  "$ref": "#/components/schemas/Output_SessionStatus"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/sessions

Administrative section: sessions

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page10

{
  "$ref": "#/components/schemas/Output_Page10"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/sessions/{id}

Administrative section: sessions

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/settings

Administrative section: settings

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_SettingsDto

{
  "$ref": "#/components/schemas/Output_SettingsDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/settings

Administrative section: settings

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_SettingsPatch

{
  "$ref": "#/components/schemas/Input_SettingsPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_SettingsDto

{
  "$ref": "#/components/schemas/Output_SettingsDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/teams

Administrative section: teams

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page4

{
  "$ref": "#/components/schemas/Output_Page4"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/teams

Administrative section: teams

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_TeamWrite

{
  "$ref": "#/components/schemas/Input_TeamWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamDto

{
  "$ref": "#/components/schemas/Output_TeamDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/teams/batch

Administrative section: teams

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem4

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem4"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_TeamDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/teams/{id}

Administrative section: teams

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/teams/{id}

Administrative section: teams

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamDto

{
  "$ref": "#/components/schemas/Output_TeamDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/teams/{id}

Administrative section: teams

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_TeamPatch

{
  "$ref": "#/components/schemas/Input_TeamPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamDto

{
  "$ref": "#/components/schemas/Output_TeamDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/teams/{id}/members

Administrative section: team-members

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page9

{
  "$ref": "#/components/schemas/Output_Page9"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/teams/{id}/members

Administrative section: team-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_MemberWrite

{
  "$ref": "#/components/schemas/Input_MemberWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamMemberDto

{
  "$ref": "#/components/schemas/Output_TeamMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/teams/{id}/members/{user_id}

Administrative section: team-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

user_id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/teams/{id}/members/{user_id}

Administrative section: team-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

user_id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamMemberDto

{
  "$ref": "#/components/schemas/Output_TeamMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PUT /admin/api/teams/{id}/members/{user_id}

Administrative section: team-members

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

user_id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_MemberPatch

{
  "$ref": "#/components/schemas/Input_MemberPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TeamMemberDto

{
  "$ref": "#/components/schemas/Output_TeamMemberDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/tls-presets

Administrative section: catalog

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TlsPresetDto

{
  "items": {
    "$ref": "#/components/schemas/Output_TlsPresetDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/tokenizer-auth

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TokenizerAuthDto

{
  "$ref": "#/components/schemas/Output_TokenizerAuthDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/tokenizer-auth

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_TokenBody

{
  "$ref": "#/components/schemas/Input_TokenBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TokenizerAuthDto

{
  "$ref": "#/components/schemas/Output_TokenizerAuthDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/tokenizer-auth/reveal

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "token": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "token"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/tokenizer-vocabs

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_VocabularyDto

{
  "items": {
    "$ref": "#/components/schemas/Output_VocabularyDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/tokenizer-vocabs

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_TokenizerFetch

{
  "$ref": "#/components/schemas/Input_TokenizerFetch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_VocabularyDto

{
  "$ref": "#/components/schemas/Output_VocabularyDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/tokenizer-vocabs/progress

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TokenizerProgressDto

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_TokenizerProgressDto"
    },
    {
      "type": "null"
    }
  ]
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/tokenizer-vocabs/{id}

Administrative section: tokenizer

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/update

Availability: Host with an update service configured

Administrative section: update

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UpdateSchedule

{
  "$ref": "#/components/schemas/Output_UpdateSchedule"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/update/announcements

Availability: Host with an update service configured

Administrative section: update

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Announcement

{
  "items": {
    "$ref": "#/components/schemas/Output_Announcement"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/update/apply

Availability: Host with an update service configured

Administrative section: update

Parameters · Request body · Responses

Parameters

channel (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

source (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AppliedUpdate

{
  "$ref": "#/components/schemas/Output_AppliedUpdate"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/update/check

Availability: Host with an update service configured

Administrative section: update

Parameters · Request body · Responses

Parameters

channel (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

source (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UpdateReport

{
  "$ref": "#/components/schemas/Output_UpdateReport"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/update/progress

Availability: Host with an update service configured

Administrative section: update

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UpdateProgress

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Output_UpdateProgress"
    },
    {
      "type": "null"
    }
  ]
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/update/rollback

Availability: Host with an update service configured

Administrative section: update

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AppliedUpdate

{
  "$ref": "#/components/schemas/Output_AppliedUpdate"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/usage

Administrative section: usage

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

One of the caller's own keys. A key that is not theirs matches nothing, because the user filter is applied as well.

{
  "default": null,
  "description": "One of the caller's own keys. A key that is not theirs matches nothing,\nbecause the user filter is applied as well.",
  "type": [
    "string",
    "null"
  ]
}

bucketMs (query) — Required: No

Bucket width for the trend. Absent means no trend is computed; present requires `toMs`, and without `fromMs` the buckets start at the first matching record.

{
  "default": null,
  "description": "Bucket width for the trend. Absent means no trend is computed; present\nrequires `toMs`, and without `fromMs` the buckets start at the first\nmatching record.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

credentialId (query) — Required: No

Admin surface only: the share of one credential's attempts. A portal refuses it for the same reason it refuses `groupBy: credential` — credential ids are the operator's, not the caller's.

{
  "default": null,
  "description": "Admin surface only: the share of one credential's attempts. A portal\nrefuses it for the same reason it refuses `groupBy: credential` —\ncredential ids are the operator's, not the caller's.",
  "type": [
    "string",
    "null"
  ]
}

fromMs (query) — Required: No

Inclusive lower bound on `startedAtMs`.

{
  "default": null,
  "description": "Inclusive lower bound on `startedAtMs`.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

groupBy (query) — Required: No

Absent means no grouped cut is computed.

Referenced structures: Input_UsageGroupBy

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Input_UsageGroupBy"
    },
    {
      "type": "null"
    }
  ],
  "default": null,
  "description": "Absent means no grouped cut is computed."
}

model (query) — Required: No

{
  "default": null,
  "type": [
    "string",
    "null"
  ]
}

operation (query) — Required: No

{
  "default": null,
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

Admin surface only: the share of one upstream provider's attempts. A portal refuses it, because it never shows a caller provider ids.

{
  "default": null,
  "description": "Admin surface only: the share of one upstream provider's attempts.\nA portal refuses it, because it never shows a caller provider ids.",
  "type": [
    "string",
    "null"
  ]
}

toMs (query) — Required: No

Exclusive upper bound.

{
  "default": null,
  "description": "Exclusive upper bound.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

userId (query) — Required: No

Ignored. See the type note.

{
  "default": null,
  "description": "Ignored. See the type note.",
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalUsageDto

{
  "$ref": "#/components/schemas/Output_PortalUsageDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/usage/records

Administrative section: usage

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_HistoryDeleted

{
  "$ref": "#/components/schemas/Output_HistoryDeleted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/usage/records

Administrative section: usage

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

Records whose structured upstream usage matches this credential.

{
  "description": "Records whose structured upstream usage matches this credential.",
  "type": [
    "string",
    "null"
  ]
}

fromMs (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

model (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

operation (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

Records whose structured upstream usage matches this provider.

{
  "description": "Records whose structured upstream usage matches this provider.",
  "type": [
    "string",
    "null"
  ]
}

requestId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

toMs (query) — Required: No

{
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UsageRecordPage

{
  "$ref": "#/components/schemas/Output_UsageRecordPage"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/usage/records/delete

Administrative section: usage

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_HistoryDelete

{
  "$ref": "#/components/schemas/Input_HistoryDelete"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_HistoryDeleted

{
  "$ref": "#/components/schemas/Output_HistoryDeleted"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/users

Administrative section: users

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

credentialId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

enabled (query) — Required: No

{
  "type": [
    "boolean",
    "null"
  ]
}

organizationId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

ownerUserId (query) — Required: No

Rows whose subject is this user or one of the user's API keys — for the families whose rule names one subject or the other.

{
  "description": "Rows whose subject is this user or one of the user's API keys — for the\nfamilies whose rule names one subject or the other.",
  "type": [
    "string",
    "null"
  ]
}

page (query) — Required: No

1-based. Zero and absent both mean the first page.

{
  "description": "1-based. Zero and absent both mean the first page.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

pageSize (query) — Required: No

Clamped to 1..=500; absent means 50.

{
  "description": "Clamped to 1..=500; absent means 50.",
  "format": "uint64",
  "minimum": 0,
  "type": [
    "integer",
    "null"
  ]
}

providerId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

search (query) — Required: No

Case-insensitive substring of the family's natural name column.

{
  "description": "Case-insensitive substring of the family's natural name column.",
  "type": [
    "string",
    "null"
  ]
}

teamId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

userId (query) — Required: No

{
  "type": [
    "string",
    "null"
  ]
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page

{
  "$ref": "#/components/schemas/Output_Page"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/users

Administrative section: users

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_UserWrite

{
  "$ref": "#/components/schemas/Input_UserWrite"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "$ref": "#/components/schemas/Output_UserDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/users/batch

Administrative section: users

Parameters · Request body · Responses

Parameters

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_BatchItem

{
  "items": {
    "$ref": "#/components/schemas/Input_BatchItem"
  },
  "type": "array"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/Output_UserDto"
      },
      {
        "type": "null"
      }
    ]
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/users/{id}

Administrative section: users

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/users/{id}

Administrative section: users

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "$ref": "#/components/schemas/Output_UserDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PATCH /admin/api/users/{id}

Administrative section: users

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_UserPatch

{
  "$ref": "#/components/schemas/Input_UserPatch"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "$ref": "#/components/schemas/Output_UserDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

PUT /admin/api/users/{id}/allowlist

Administrative section: users

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_AllowlistBody

{
  "$ref": "#/components/schemas/Input_AllowlistBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "$ref": "#/components/schemas/Output_UserDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/users/{id}/password

Administrative section: users

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "$ref": "#/components/schemas/Output_UserDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /admin/api/users/{id}/password

Administrative section: users

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Request body

application/json

Referenced structures: Input_PasswordBody

{
  "$ref": "#/components/schemas/Input_PasswordBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserDto

{
  "$ref": "#/components/schemas/Output_UserDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /admin/api/users/{id}/sessions

Administrative section: sessions

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "revoked": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "revoked"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /admin/api/users/{id}/sessions

Administrative section: sessions

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

x-gproxy-admin-scope (header) — Required: No

Administrative scope selected by the caller.

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_Page10

{
  "$ref": "#/components/schemas/Output_Page10"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

Portal

GET /portal/api/context

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalContextDto

{
  "$ref": "#/components/schemas/Output_PortalContextDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/keys

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalKeyDto

{
  "items": {
    "$ref": "#/components/schemas/Output_PortalKeyDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /portal/api/keys

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_PortalKeyCreate

{
  "$ref": "#/components/schemas/Input_PortalKeyCreate"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalKeyCreated

{
  "$ref": "#/components/schemas/Output_PortalKeyCreated"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /portal/api/keys/{id}

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /portal/api/keys/{id}/rotate

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalKeyCreated

{
  "$ref": "#/components/schemas/Output_PortalKeyCreated"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/keys/{id}/secret

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalKeySecretDto

{
  "$ref": "#/components/schemas/Output_PortalKeySecretDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /portal/api/login

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_LoginBody

{
  "$ref": "#/components/schemas/Input_LoginBody"
}

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "expiresAtMs": {
      "format": "int64",
      "type": "integer"
    },
    "sessionId": {
      "type": "string"
    },
    "token": {
      "type": "string"
    }
  },
  "required": [
    "sessionId",
    "token",
    "expiresAtMs"
  ],
  "type": "object"
}

{
  "Set-Cookie": {
    "description": "Console session cookie",
    "schema": {
      "type": "string"
    }
  }
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /portal/api/logout

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "endedSession": {
      "type": "boolean"
    }
  },
  "required": [
    "endedSession"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/models

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalModelDto

{
  "items": {
    "$ref": "#/components/schemas/Output_PortalModelDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/oauth-sessions

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalOAuthSessionDto

{
  "items": {
    "$ref": "#/components/schemas/Output_PortalOAuthSessionDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

DELETE /portal/api/oauth-sessions/{id}

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/oauth/device

Parameters · Request body · Responses

Parameters

userCode (query) — Required: Yes

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DeviceDetails

{
  "$ref": "#/components/schemas/Output_DeviceDetails"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /portal/api/oauth/device

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_DeviceDecisionBody

{
  "$ref": "#/components/schemas/Input_DeviceDecisionBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DeviceDecided

{
  "$ref": "#/components/schemas/Output_DeviceDecided"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

POST /portal/api/password

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_PortalPasswordChange

{
  "$ref": "#/components/schemas/Input_PortalPasswordChange"
}

Responses

Status: 204 — Success without a response body

No body

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/quota

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalQuotaWindowDto

{
  "items": {
    "$ref": "#/components/schemas/Output_PortalQuotaWindowDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/requests

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalRequestDto

{
  "items": {
    "$ref": "#/components/schemas/Output_PortalRequestDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/sessions

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_UserSessionDto

{
  "items": {
    "$ref": "#/components/schemas/Output_UserSessionDto"
  },
  "type": "array"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /portal/api/usage

Parameters · Request body · Responses

Parameters

apiKeyId (query) — Required: No

One of the caller's own keys. A key that is not theirs matches nothing, because the user filter is applied as well.

{
  "default": null,
  "description": "One of the caller's own keys. A key that is not theirs matches nothing,\nbecause the user filter is applied as well.",
  "type": [
    "string",
    "null"
  ]
}

bucketMs (query) — Required: No

Bucket width for the trend. Absent means no trend is computed; present requires `toMs`, and without `fromMs` the buckets start at the first matching record.

{
  "default": null,
  "description": "Bucket width for the trend. Absent means no trend is computed; present\nrequires `toMs`, and without `fromMs` the buckets start at the first\nmatching record.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

credentialId (query) — Required: No

Admin surface only: the share of one credential's attempts. A portal refuses it for the same reason it refuses `groupBy: credential` — credential ids are the operator's, not the caller's.

{
  "default": null,
  "description": "Admin surface only: the share of one credential's attempts. A portal\nrefuses it for the same reason it refuses `groupBy: credential` —\ncredential ids are the operator's, not the caller's.",
  "type": [
    "string",
    "null"
  ]
}

fromMs (query) — Required: No

Inclusive lower bound on `startedAtMs`.

{
  "default": null,
  "description": "Inclusive lower bound on `startedAtMs`.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

groupBy (query) — Required: No

Absent means no grouped cut is computed.

Referenced structures: Input_UsageGroupBy

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/Input_UsageGroupBy"
    },
    {
      "type": "null"
    }
  ],
  "default": null,
  "description": "Absent means no grouped cut is computed."
}

model (query) — Required: No

{
  "default": null,
  "type": [
    "string",
    "null"
  ]
}

operation (query) — Required: No

{
  "default": null,
  "type": [
    "string",
    "null"
  ]
}

providerId (query) — Required: No

Admin surface only: the share of one upstream provider's attempts. A portal refuses it, because it never shows a caller provider ids.

{
  "default": null,
  "description": "Admin surface only: the share of one upstream provider's attempts.\nA portal refuses it, because it never shows a caller provider ids.",
  "type": [
    "string",
    "null"
  ]
}

toMs (query) — Required: No

Exclusive upper bound.

{
  "default": null,
  "description": "Exclusive upper bound.",
  "format": "int64",
  "type": [
    "integer",
    "null"
  ]
}

userId (query) — Required: No

Ignored. See the type note.

{
  "default": null,
  "description": "Ignored. See the type note.",
  "type": [
    "string",
    "null"
  ]
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_PortalUsageDto

{
  "$ref": "#/components/schemas/Output_PortalUsageDto"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

OAuth

GET /.well-known/oauth-authorization-server/v1

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthorizationServerMetadata

{
  "$ref": "#/components/schemas/Output_AuthorizationServerMetadata"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

GET /.well-known/oauth-authorization-server/{mount}/v1

Parameters · Request body · Responses

Parameters

mount (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthorizationServerMetadata

{
  "$ref": "#/components/schemas/Output_AuthorizationServerMetadata"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

GET /v1/.well-known/oauth-authorization-server

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthorizationServerMetadata

{
  "$ref": "#/components/schemas/Output_AuthorizationServerMetadata"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

GET /v1/oauth/authorize

Accept: text/html redirects to consent without authentication. JSON details require a console session or management API key.

Parameters · Request body · Responses

Parameters

client_id (query) — Required: No

{
  "default": "",
  "type": "string"
}

code_challenge (query) — Required: No

The base64url SHA-256 of the client's verifier (RFC 7636 §4.2).

{
  "default": "",
  "description": "The base64url SHA-256 of the client's verifier (RFC 7636 §4.2).",
  "type": "string"
}

code_challenge_method (query) — Required: No

Must be `S256`.

{
  "default": "",
  "description": "Must be `S256`.",
  "type": "string"
}

redirect_uri (query) — Required: No

Matched **exactly** against `oauth_clients.redirect_uris`.

{
  "default": "",
  "description": "Matched **exactly** against `oauth_clients.redirect_uris`.",
  "type": "string"
}

response_type (query) — Required: No

Must be `code`. This issuer has no implicit and no hybrid flow.

{
  "default": "",
  "description": "Must be `code`. This issuer has no implicit and no hybrid flow.",
  "type": "string"
}

scope (query) — Required: No

Space-delimited, per RFC 6749 §3.3. Empty asks for no scope.

{
  "default": "",
  "description": "Space-delimited, per RFC 6749 §3.3. Empty asks for no scope.",
  "type": "string"
}

state (query) — Required: No

Opaque client value, echoed back untouched on both outcomes. It is the client's CSRF defence and this issuer never interprets it.

{
  "default": null,
  "description": "Opaque client value, echoed back untouched on both outcomes. It is the\nclient's CSRF defence and this issuer never interprets it.",
  "type": [
    "string",
    "null"
  ]
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthorizeDetails

{
  "$ref": "#/components/schemas/Output_AuthorizeDetails"
}

Status: 302 — Browser consent handoff

No body

{
  "Location": {
    "schema": {
      "type": "string"
    }
  }
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

POST /v1/oauth/authorize

Parameters · Request body · Responses

Parameters

client_id (query) — Required: No

{
  "default": "",
  "type": "string"
}

code_challenge (query) — Required: No

The base64url SHA-256 of the client's verifier (RFC 7636 §4.2).

{
  "default": "",
  "description": "The base64url SHA-256 of the client's verifier (RFC 7636 §4.2).",
  "type": "string"
}

code_challenge_method (query) — Required: No

Must be `S256`.

{
  "default": "",
  "description": "Must be `S256`.",
  "type": "string"
}

redirect_uri (query) — Required: No

Matched **exactly** against `oauth_clients.redirect_uris`.

{
  "default": "",
  "description": "Matched **exactly** against `oauth_clients.redirect_uris`.",
  "type": "string"
}

response_type (query) — Required: No

Must be `code`. This issuer has no implicit and no hybrid flow.

{
  "default": "",
  "description": "Must be `code`. This issuer has no implicit and no hybrid flow.",
  "type": "string"
}

scope (query) — Required: No

Space-delimited, per RFC 6749 §3.3. Empty asks for no scope.

{
  "default": "",
  "description": "Space-delimited, per RFC 6749 §3.3. Empty asks for no scope.",
  "type": "string"
}

state (query) — Required: No

Opaque client value, echoed back untouched on both outcomes. It is the client's CSRF defence and this issuer never interprets it.

{
  "default": null,
  "description": "Opaque client value, echoed back untouched on both outcomes. It is the\nclient's CSRF defence and this issuer never interprets it.",
  "type": [
    "string",
    "null"
  ]
}

Request body

application/json

Referenced structures: Input_DecisionBody

{
  "$ref": "#/components/schemas/Input_DecisionBody"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthorizeOutcome

{
  "properties": {
    "location": {
      "type": "string"
    },
    "outcome": {
      "$ref": "#/components/schemas/Output_AuthorizeOutcome"
    }
  },
  "required": [
    "location",
    "outcome"
  ],
  "type": "object"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

POST /v1/oauth/device/code

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_DeviceCodeRequest

{
  "$ref": "#/components/schemas/Input_DeviceCodeRequest"
}

application/x-www-form-urlencoded

Referenced structures: Input_DeviceCodeRequest

{
  "$ref": "#/components/schemas/Input_DeviceCodeRequest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_DeviceCodeResponse

{
  "$ref": "#/components/schemas/Output_DeviceCodeResponse"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

GET /v1/oauth/metadata

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

Referenced structures: Output_AuthorizationServerMetadata

{
  "$ref": "#/components/schemas/Output_AuthorizationServerMetadata"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

POST /v1/oauth/revoke

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_RevokeRequest

{
  "$ref": "#/components/schemas/Input_RevokeRequest"
}

application/x-www-form-urlencoded

Referenced structures: Input_RevokeRequest

{
  "$ref": "#/components/schemas/Input_RevokeRequest"
}

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "revoked": {
      "type": "boolean"
    }
  },
  "required": [
    "revoked"
  ],
  "type": "object"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

POST /v1/oauth/token

Parameters · Request body · Responses

Request body

application/json

Referenced structures: Input_TokenRequest

{
  "$ref": "#/components/schemas/Input_TokenRequest"
}

application/x-www-form-urlencoded

Referenced structures: Input_TokenRequest

{
  "$ref": "#/components/schemas/Input_TokenRequest"
}

Responses

Status: 200 — Success

application/json

Referenced structures: Output_TokenResponse

{
  "$ref": "#/components/schemas/Output_TokenResponse"
}

Status: default — OAuth error

application/json

Referenced structures: Output_OAuthErrorBody

{
  "$ref": "#/components/schemas/Output_OAuthErrorBody"
}

System

GET /healthz

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "revision": {
      "type": "integer"
    },
    "status": {
      "const": "ok"
    }
  },
  "required": [
    "status",
    "revision"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /info

Parameters · Request body · Responses

Responses

Status: 200 — Success

application/json

{
  "properties": {
    "fontManagement": {
      "type": "boolean"
    },
    "hash": {
      "type": "string"
    },
    "instanceName": {
      "type": "string"
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "instanceName",
    "version",
    "hash",
    "fontManagement"
  ],
  "type": "object"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /publications/{id}

Parameters · Request body · Responses

Parameters

id (path) — Required: Yes

{
  "type": "string"
}

Responses

Status: 200 — Success

*/*

{
  "format": "binary",
  "type": "string"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}

GET /robots.txt

Parameters · Request body · Responses

Responses

Status: 200 — Success

text/plain

{
  "type": "string"
}

Status: default — Gateway error

application/json

Referenced structures: Output_Envelope

{
  "$ref": "#/components/schemas/Output_Envelope"
}