headscale.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "headscale/v1/headscale.proto",
    "version": "version not set"
  },
  "tags": [
    {
      "name": "HeadscaleService"
    }
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/api/v1/apikey": {
      "get": {
        "operationId": "HeadscaleService_ListApiKeys",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ListApiKeysResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "tags": [
          "HeadscaleService"
        ]
      },
      "post": {
        "summary": "--- ApiKeys start ---",
        "operationId": "HeadscaleService_CreateApiKey",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1CreateApiKeyResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1CreateApiKeyRequest"
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/apikey/expire": {
      "post": {
        "operationId": "HeadscaleService_ExpireApiKey",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ExpireApiKeyResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1ExpireApiKeyRequest"
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/debug/machine": {
      "post": {
        "summary": "--- Machine start ---",
        "operationId": "HeadscaleService_DebugCreateMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1DebugCreateMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1DebugCreateMachineRequest"
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine": {
      "get": {
        "operationId": "HeadscaleService_ListMachines",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ListMachinesResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "namespace",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/register": {
      "post": {
        "operationId": "HeadscaleService_RegisterMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1RegisterMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "namespace",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "key",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/{machineId}": {
      "get": {
        "operationId": "HeadscaleService_GetMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1GetMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      },
      "delete": {
        "operationId": "HeadscaleService_DeleteMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1DeleteMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/{machineId}/expire": {
      "post": {
        "operationId": "HeadscaleService_ExpireMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ExpireMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/{machineId}/namespace": {
      "post": {
        "operationId": "HeadscaleService_MoveMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1MoveMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          },
          {
            "name": "namespace",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/{machineId}/rename/{newName}": {
      "post": {
        "operationId": "HeadscaleService_RenameMachine",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1RenameMachineResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          },
          {
            "name": "newName",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/{machineId}/routes": {
      "get": {
        "summary": "--- Route start ---",
        "operationId": "HeadscaleService_GetMachineRoute",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1GetMachineRouteResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      },
      "post": {
        "operationId": "HeadscaleService_EnableMachineRoutes",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1EnableMachineRoutesResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          },
          {
            "name": "routes",
            "in": "query",
            "required": false,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/machine/{machineId}/tags": {
      "post": {
        "operationId": "HeadscaleService_SetTags",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1SetTagsResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "machineId",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "uint64"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/namespace": {
      "get": {
        "operationId": "HeadscaleService_ListNamespaces",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ListNamespacesResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "tags": [
          "HeadscaleService"
        ]
      },
      "post": {
        "operationId": "HeadscaleService_CreateNamespace",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1CreateNamespaceResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1CreateNamespaceRequest"
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/namespace/{name}": {
      "get": {
        "summary": "--- Namespace start ---",
        "operationId": "HeadscaleService_GetNamespace",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1GetNamespaceResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      },
      "delete": {
        "operationId": "HeadscaleService_DeleteNamespace",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1DeleteNamespaceResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/namespace/{oldName}/rename/{newName}": {
      "post": {
        "operationId": "HeadscaleService_RenameNamespace",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1RenameNamespaceResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "oldName",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "newName",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/preauthkey": {
      "get": {
        "operationId": "HeadscaleService_ListPreAuthKeys",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ListPreAuthKeysResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "namespace",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      },
      "post": {
        "summary": "--- PreAuthKeys start ---",
        "operationId": "HeadscaleService_CreatePreAuthKey",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1CreatePreAuthKeyResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1CreatePreAuthKeyRequest"
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    },
    "/api/v1/preauthkey/expire": {
      "post": {
        "operationId": "HeadscaleService_ExpirePreAuthKey",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1ExpirePreAuthKeyResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1ExpirePreAuthKeyRequest"
            }
          }
        ],
        "tags": [
          "HeadscaleService"
        ]
      }
    }
  },
  "definitions": {
    "protobufAny": {
      "type": "object",
      "properties": {
        "@type": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "rpcStatus": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/protobufAny"
          }
        }
      }
    },
    "v1ApiKey": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uint64"
        },
        "prefix": {
          "type": "string"
        },
        "expiration": {
          "type": "string",
          "format": "date-time"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "lastSeen": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1CreateApiKeyRequest": {
      "type": "object",
      "properties": {
        "expiration": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1CreateApiKeyResponse": {
      "type": "object",
      "properties": {
        "apiKey": {
          "type": "string"
        }
      }
    },
    "v1CreateNamespaceRequest": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "v1CreateNamespaceResponse": {
      "type": "object",
      "properties": {
        "namespace": {
          "$ref": "#/definitions/v1Namespace"
        }
      }
    },
    "v1CreatePreAuthKeyRequest": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string"
        },
        "reusable": {
          "type": "boolean"
        },
        "ephemeral": {
          "type": "boolean"
        },
        "expiration": {
          "type": "string",
          "format": "date-time"
        },
        "aclTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v1CreatePreAuthKeyResponse": {
      "type": "object",
      "properties": {
        "preAuthKey": {
          "$ref": "#/definitions/v1PreAuthKey"
        }
      }
    },
    "v1DebugCreateMachineRequest": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "routes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v1DebugCreateMachineResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    },
    "v1DeleteMachineResponse": {
      "type": "object"
    },
    "v1DeleteNamespaceResponse": {
      "type": "object"
    },
    "v1EnableMachineRoutesResponse": {
      "type": "object",
      "properties": {
        "routes": {
          "$ref": "#/definitions/v1Routes"
        }
      }
    },
    "v1ExpireApiKeyRequest": {
      "type": "object",
      "properties": {
        "prefix": {
          "type": "string"
        }
      }
    },
    "v1ExpireApiKeyResponse": {
      "type": "object"
    },
    "v1ExpireMachineResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    },
    "v1ExpirePreAuthKeyRequest": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string"
        },
        "key": {
          "type": "string"
        }
      }
    },
    "v1ExpirePreAuthKeyResponse": {
      "type": "object"
    },
    "v1GetMachineResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    },
    "v1GetMachineRouteResponse": {
      "type": "object",
      "properties": {
        "routes": {
          "$ref": "#/definitions/v1Routes"
        }
      }
    },
    "v1GetNamespaceResponse": {
      "type": "object",
      "properties": {
        "namespace": {
          "$ref": "#/definitions/v1Namespace"
        }
      }
    },
    "v1ListApiKeysResponse": {
      "type": "object",
      "properties": {
        "apiKeys": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1ApiKey"
          }
        }
      }
    },
    "v1ListMachinesResponse": {
      "type": "object",
      "properties": {
        "machines": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1Machine"
          }
        }
      }
    },
    "v1ListNamespacesResponse": {
      "type": "object",
      "properties": {
        "namespaces": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1Namespace"
          }
        }
      }
    },
    "v1ListPreAuthKeysResponse": {
      "type": "object",
      "properties": {
        "preAuthKeys": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1PreAuthKey"
          }
        }
      }
    },
    "v1Machine": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uint64"
        },
        "machineKey": {
          "type": "string"
        },
        "nodeKey": {
          "type": "string"
        },
        "discoKey": {
          "type": "string"
        },
        "ipAddresses": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "name": {
          "type": "string"
        },
        "namespace": {
          "$ref": "#/definitions/v1Namespace"
        },
        "lastSeen": {
          "type": "string",
          "format": "date-time"
        },
        "lastSuccessfulUpdate": {
          "type": "string",
          "format": "date-time"
        },
        "expiry": {
          "type": "string",
          "format": "date-time"
        },
        "preAuthKey": {
          "$ref": "#/definitions/v1PreAuthKey"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "registerMethod": {
          "$ref": "#/definitions/v1RegisterMethod"
        },
        "forcedTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "invalidTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "validTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "givenName": {
          "type": "string"
        }
      }
    },
    "v1MoveMachineResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    },
    "v1Namespace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1PreAuthKey": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "reusable": {
          "type": "boolean"
        },
        "ephemeral": {
          "type": "boolean"
        },
        "used": {
          "type": "boolean"
        },
        "expiration": {
          "type": "string",
          "format": "date-time"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "aclTags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v1RegisterMachineResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    },
    "v1RegisterMethod": {
      "type": "string",
      "enum": [
        "REGISTER_METHOD_UNSPECIFIED",
        "REGISTER_METHOD_AUTH_KEY",
        "REGISTER_METHOD_CLI",
        "REGISTER_METHOD_OIDC"
      ],
      "default": "REGISTER_METHOD_UNSPECIFIED"
    },
    "v1RenameMachineResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    },
    "v1RenameNamespaceResponse": {
      "type": "object",
      "properties": {
        "namespace": {
          "$ref": "#/definitions/v1Namespace"
        }
      }
    },
    "v1Routes": {
      "type": "object",
      "properties": {
        "advertisedRoutes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enabledRoutes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v1SetTagsResponse": {
      "type": "object",
      "properties": {
        "machine": {
          "$ref": "#/definitions/v1Machine"
        }
      }
    }
  }
}