openapi-spec.json

{
  "components": {
    "schemas": {
      "GetAccount_200_Response": {
        "properties": {
          "account_type": {
            "type": "string"
          },
          "created": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "license": {
            "type": "string"
          },
          "premium_data": {
            "type": "number"
          },
          "quota": {
            "type": "number"
          },
          "referral_count": {
            "type": "number"
          },
          "referral_renewal_countdown": {
            "type": "number"
          },
          "role": {
            "type": "string"
          },
          "updated": {
            "type": "string"
          },
          "warp_plus": {
            "type": "boolean"
          }
        },
        "required": [
          "account_type",
          "created",
          "id",
          "license",
          "premium_data",
          "quota",
          "referral_count",
          "referral_renewal_countdown",
          "role",
          "updated",
          "warp_plus"
        ],
        "type": "object"
      },
      "GetBoundDevices_200_Response": {
        "properties": {
          "activated": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "created": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "activated",
          "active",
          "created",
          "id",
          "model",
          "role",
          "type"
        ],
        "type": "object"
      },
      "GetClientConfig_200_Response": {
        "properties": {
          "captive_portal": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "networks": {
                  "items": {
                    "properties": {
                      "address": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "address"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "required": [
                "name",
                "networks"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "denylist": {
            "items": {
              "properties": {
                "android-packages": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "name": {
                  "type": "string"
                },
                "networks": {
                  "properties": {
                    "v4": {
                      "items": {
                        "properties": {
                          "address": {
                            "type": "string"
                          },
                          "netmask": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "address",
                          "netmask"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "v6": {
                      "items": {
                        "properties": {
                          "address": {
                            "type": "string"
                          },
                          "prefix": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "address",
                          "prefix"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "v4",
                    "v6"
                  ],
                  "type": "object"
                },
                "visible": {
                  "type": "boolean"
                }
              },
              "required": [
                "name",
                "visible"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "premium_data_bytes": {
            "type": "number"
          },
          "referral_reward_bytes": {
            "type": "number"
          }
        },
        "required": [
          "captive_portal",
          "denylist",
          "premium_data_bytes",
          "referral_reward_bytes"
        ],
        "type": "object"
      },
      "GetSourceDevice_200_Response": {
        "properties": {
          "account": {
            "properties": {
              "account_type": {
                "type": "string"
              },
              "created": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "license": {
                "type": "string"
              },
              "premium_data": {
                "type": "number"
              },
              "quota": {
                "type": "number"
              },
              "referral_count": {
                "type": "number"
              },
              "referral_renewal_countdown": {
                "type": "number"
              },
              "role": {
                "type": "string"
              },
              "updated": {
                "type": "string"
              },
              "usage": {
                "type": "number"
              },
              "warp_plus": {
                "type": "boolean"
              }
            },
            "required": [
              "account_type",
              "created",
              "id",
              "license",
              "premium_data",
              "quota",
              "referral_count",
              "referral_renewal_countdown",
              "role",
              "updated",
              "usage",
              "warp_plus"
            ],
            "type": "object"
          },
          "config": {
            "properties": {
              "client_id": {
                "type": "string"
              },
              "interface": {
                "properties": {
                  "addresses": {
                    "properties": {
                      "v4": {
                        "type": "string"
                      },
                      "v6": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "v4",
                      "v6"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "addresses"
                ],
                "type": "object"
              },
              "peers": {
                "items": {
                  "properties": {
                    "endpoint": {
                      "properties": {
                        "host": {
                          "type": "string"
                        },
                        "v4": {
                          "type": "string"
                        },
                        "v6": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "host",
                        "v4",
                        "v6"
                      ],
                      "type": "object"
                    },
                    "public_key": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "endpoint",
                    "public_key"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "services": {
                "properties": {
                  "http_proxy": {
                    "type": "string"
                  }
                },
                "required": [
                  "http_proxy"
                ],
                "type": "object"
              }
            },
            "required": [
              "client_id",
              "interface",
              "peers",
              "services"
            ],
            "type": "object"
          },
          "created": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "fcm_token": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "install_id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "place": {
            "type": "number"
          },
          "tos": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated": {
            "type": "string"
          },
          "waitlist_enabled": {
            "type": "boolean"
          },
          "warp_enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "account",
          "config",
          "created",
          "enabled",
          "fcm_token",
          "id",
          "install_id",
          "key",
          "locale",
          "model",
          "name",
          "place",
          "tos",
          "type",
          "updated",
          "waitlist_enabled",
          "warp_enabled"
        ],
        "type": "object"
      },
      "Register_200_Response": {
        "properties": {
          "account": {
            "properties": {
              "account_type": {
                "type": "string"
              },
              "created": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "license": {
                "type": "string"
              },
              "premium_data": {
                "type": "number"
              },
              "quota": {
                "type": "number"
              },
              "referral_count": {
                "type": "number"
              },
              "referral_renewal_countdown": {
                "type": "number"
              },
              "role": {
                "type": "string"
              },
              "updated": {
                "type": "string"
              },
              "usage": {
                "type": "number"
              },
              "warp_plus": {
                "type": "boolean"
              }
            },
            "required": [
              "account_type",
              "created",
              "id",
              "license",
              "premium_data",
              "quota",
              "referral_count",
              "referral_renewal_countdown",
              "role",
              "updated",
              "usage",
              "warp_plus"
            ],
            "type": "object"
          },
          "config": {
            "properties": {
              "client_id": {
                "type": "string"
              },
              "interface": {
                "properties": {
                  "addresses": {
                    "properties": {
                      "v4": {
                        "type": "string"
                      },
                      "v6": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "v4",
                      "v6"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "addresses"
                ],
                "type": "object"
              },
              "peers": {
                "items": {
                  "properties": {
                    "endpoint": {
                      "properties": {
                        "host": {
                          "type": "string"
                        },
                        "v4": {
                          "type": "string"
                        },
                        "v6": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "host",
                        "v4",
                        "v6"
                      ],
                      "type": "object"
                    },
                    "public_key": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "endpoint",
                    "public_key"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "services": {
                "properties": {
                  "http_proxy": {
                    "type": "string"
                  }
                },
                "required": [
                  "http_proxy"
                ],
                "type": "object"
              }
            },
            "required": [
              "client_id",
              "interface",
              "peers",
              "services"
            ],
            "type": "object"
          },
          "created": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "fcm_token": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "install_id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "place": {
            "type": "number"
          },
          "token": {
            "type": "string"
          },
          "tos": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated": {
            "type": "string"
          },
          "waitlist_enabled": {
            "type": "boolean"
          },
          "warp_enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "account",
          "config",
          "created",
          "enabled",
          "fcm_token",
          "id",
          "install_id",
          "key",
          "locale",
          "model",
          "name",
          "place",
          "token",
          "tos",
          "type",
          "updated",
          "waitlist_enabled",
          "warp_enabled"
        ],
        "type": "object"
      },
      "Register_Request": {
        "properties": {
          "fcm_token": {
            "type": "string"
          },
          "install_id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "tos": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "fcm_token",
          "install_id",
          "key",
          "locale",
          "model",
          "tos",
          "type"
        ],
        "type": "object"
      },
      "ResetAccountLicense_200_Response": {
        "properties": {
          "license": {
            "type": "string"
          }
        },
        "required": [
          "license"
        ],
        "type": "object"
      },
      "UpdateAccount_200_Response": {
        "properties": {
          "created": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "premium_data": {
            "type": "number"
          },
          "quota": {
            "type": "number"
          },
          "referral_count": {
            "type": "number"
          },
          "referral_renewal_countdown": {
            "type": "number"
          },
          "role": {
            "type": "string"
          },
          "updated": {
            "type": "string"
          },
          "warp_plus": {
            "type": "boolean"
          }
        },
        "required": [
          "created",
          "id",
          "premium_data",
          "quota",
          "referral_count",
          "referral_renewal_countdown",
          "role",
          "updated",
          "warp_plus"
        ],
        "type": "object"
      },
      "UpdateAccount_Request": {
        "properties": {
          "license": {
            "type": "string"
          }
        },
        "required": [
          "license"
        ],
        "type": "object"
      },
      "UpdateBoundDevice_200_Response": {
        "properties": {
          "activated": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "created": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "activated",
          "active",
          "created",
          "id",
          "model",
          "role",
          "type"
        ],
        "type": "object"
      },
      "UpdateBoundDevice_Request": {
        "properties": {
          "active": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "UpdateSourceDevice_200_Response": {
        "properties": {
          "account": {
            "properties": {
              "account_type": {
                "type": "string"
              },
              "created": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "license": {
                "type": "string"
              },
              "premium_data": {
                "type": "number"
              },
              "quota": {
                "type": "number"
              },
              "referral_count": {
                "type": "number"
              },
              "referral_renewal_countdown": {
                "type": "number"
              },
              "role": {
                "type": "string"
              },
              "updated": {
                "type": "string"
              },
              "warp_plus": {
                "type": "boolean"
              }
            },
            "required": [
              "account_type",
              "created",
              "id",
              "license",
              "premium_data",
              "quota",
              "referral_count",
              "referral_renewal_countdown",
              "role",
              "updated",
              "warp_plus"
            ],
            "type": "object"
          },
          "config": {
            "properties": {
              "client_id": {
                "type": "string"
              },
              "interface": {
                "properties": {
                  "addresses": {
                    "properties": {
                      "v4": {
                        "type": "string"
                      },
                      "v6": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "v4",
                      "v6"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "addresses"
                ],
                "type": "object"
              },
              "peers": {
                "items": {
                  "properties": {
                    "endpoint": {
                      "properties": {
                        "host": {
                          "type": "string"
                        },
                        "v4": {
                          "type": "string"
                        },
                        "v6": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "host",
                        "v4",
                        "v6"
                      ],
                      "type": "object"
                    },
                    "public_key": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "endpoint",
                    "public_key"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "services": {
                "properties": {
                  "http_proxy": {
                    "type": "string"
                  }
                },
                "required": [
                  "http_proxy"
                ],
                "type": "object"
              }
            },
            "required": [
              "client_id",
              "interface",
              "peers",
              "services"
            ],
            "type": "object"
          },
          "created": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "fcm_token": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "install_id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "locale": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "place": {
            "type": "number"
          },
          "tos": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated": {
            "type": "string"
          },
          "waitlist_enabled": {
            "type": "boolean"
          },
          "warp_enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "account",
          "config",
          "created",
          "enabled",
          "fcm_token",
          "id",
          "install_id",
          "key",
          "locale",
          "model",
          "name",
          "place",
          "tos",
          "type",
          "updated",
          "waitlist_enabled",
          "warp_enabled"
        ],
        "type": "object"
      },
      "UpdateSourceDevice_Request": {
        "properties": {
          "key": {
            "type": "string"
          }
        },
        "required": [
          "key"
        ],
        "type": "object"
      }
    }
  },
  "info": {
    "title": "untitled API",
    "version": "536"
  },
  "openapi": "3.0.1",
  "paths": {
    "/{apiVersion}/client_config": {
      "get": {
        "operationId": "GetClientConfig",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetClientConfig_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "GetClientConfig"
      },
      "parameters": [
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ]
    },
    "/{apiVersion}/reg": {
      "parameters": [
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "operationId": "Register",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Register_Request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Register_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "Register"
      }
    },
    "/{apiVersion}/reg/{sourceDeviceId}": {
      "get": {
        "operationId": "GetSourceDevice",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetSourceDevice_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "GetSourceDevice"
      },
      "parameters": [
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "in": "path",
          "name": "sourceDeviceId",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "patch": {
        "operationId": "UpdateSourceDevice",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateSourceDevice_Request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateSourceDevice_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "UpdateSourceDevice"
      }
    },
    "/{apiVersion}/reg/{sourceDeviceId}/account": {
      "get": {
        "operationId": "GetAccount",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAccount_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "GetAccount"
      },
      "parameters": [
        {
          "in": "path",
          "name": "sourceDeviceId",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "put": {
        "operationId": "UpdateAccount",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateAccount_Request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateAccount_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "UpdateAccount"
      }
    },
    "/{apiVersion}/reg/{sourceDeviceId}/account/devices": {
      "get": {
        "operationId": "GetBoundDevices",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/GetBoundDevices_200_Response"
                  },
                  "type": "array"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "GetBoundDevices"
      },
      "parameters": [
        {
          "in": "path",
          "name": "sourceDeviceId",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ]
    },
    "/{apiVersion}/reg/{sourceDeviceId}/account/license": {
      "parameters": [
        {
          "in": "path",
          "name": "sourceDeviceId",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "operationId": "ResetAccountLicense",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResetAccountLicense_200_Response"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "ResetAccountLicense"
      }
    },
    "/{apiVersion}/reg/{sourceDeviceId}/account/reg/{boundDeviceId}": {
      "parameters": [
        {
          "in": "path",
          "name": "sourceDeviceId",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "in": "path",
          "name": "apiVersion",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "in": "path",
          "name": "boundDeviceId",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "patch": {
        "operationId": "UpdateBoundDevice",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateBoundDevice_Request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/UpdateBoundDevice_200_Response"
                  },
                  "type": "array"
                }
              }
            },
            "description": ""
          }
        },
        "summary": "UpdateBoundDevice"
      }
    }
  }
}