Other · API

Generated from the OpenAPI snapshot. Source summaries remain unchanged; JSON schemas below are the exact exported definitions.

GET /api/v1/team/group-vaults/sync

Authentication: bearer token

Required route scopes: admin

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

No request body declared.

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

DELETE /api/v1/team/group-vaults/sync/{id}

Authentication: bearer token

Required route scopes: admin

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

Name	Location	Required	Description
`id`	path	Yes

Full parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

No request body declared.

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/geo/lookup

Authentication: bearer token

Required route scopes: proxies:read

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

Request body · required

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "ip"
        ],
        "properties": {
          "ip": {
            "type": "string",
            "minLength": 2,
            "maxLength": 45
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "country"
          ],
          "properties": {
            "country": {
              "type": [
                "null",
                "string"
              ]
            }
          }
        }
      }
    }
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

Complete operation definition

OpenAPI JSON

{
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "ip"
          ],
          "properties": {
            "ip": {
              "type": "string",
              "minLength": 2,
              "maxLength": 45
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "proxies:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "country"
            ],
            "properties": {
              "country": {
                "type": [
                  "null",
                  "string"
                ]
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

GET /api/v1/runtime/once

Authentication: bearer token

Required route scopes: runtime:control

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

No request body declared.

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "x-required-scopes": [
    "runtime:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

DELETE /api/v1/runtime/once/{id}

Authentication: bearer token

Required route scopes: runtime:control

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

Name	Location	Required	Description
`id`	path	Yes

Full parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

No request body declared.

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "runtime:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/profiles/import/nstbrowser/supplement/preview

Authentication: bearer token

Required route scopes: admin, profiles:write, cookies:write

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

Request body · required

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "metadata",
          "ids"
        ],
        "properties": {
          "metadata": {},
          "source_root": {
            "type": "string",
            "maxLength": 2048
          },
          "ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "minItems": 1,
            "maxItems": 1000
          },
          "replace_existing": {
            "type": "boolean"
          },
          "expected": {
            "type": "object",
            "additionalProperties": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "metadata",
            "ids"
          ],
          "properties": {
            "metadata": {},
            "source_root": {
              "type": "string",
              "maxLength": 2048
            },
            "ids": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64
              },
              "minItems": 1,
              "maxItems": 1000
            },
            "replace_existing": {
              "type": "boolean"
            },
            "expected": {
              "type": "object",
              "additionalProperties": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              }
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "admin",
    "profiles:write",
    "cookies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/profiles/import/nstbrowser/supplement

Authentication: bearer token

Required route scopes: admin, profiles:write, cookies:write

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

Request body · required

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "metadata",
          "ids"
        ],
        "properties": {
          "metadata": {},
          "source_root": {
            "type": "string",
            "maxLength": 2048
          },
          "ids": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "minItems": 1,
            "maxItems": 1000
          },
          "replace_existing": {
            "type": "boolean"
          },
          "expected": {
            "type": "object",
            "additionalProperties": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "metadata",
            "ids"
          ],
          "properties": {
            "metadata": {},
            "source_root": {
              "type": "string",
              "maxLength": 2048
            },
            "ids": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64
              },
              "minItems": 1,
              "maxItems": 1000
            },
            "replace_existing": {
              "type": "boolean"
            },
            "expected": {
              "type": "object",
              "additionalProperties": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              }
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "admin",
    "profiles:write",
    "cookies:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

GET /api/v1/extensions/policy

Authentication: bearer token

Required route scopes: profiles:read

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

No request body declared.

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "x-required-scopes": [
    "profiles:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

PUT /api/v1/extensions/policy

Authentication: bearer token

Required route scopes: admin

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

No path or query parameters declared.

Request body · required

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "managed"
        ],
        "properties": {
          "managed": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "managed"
          ],
          "properties": {
            "managed": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/extensions/versions/{id}/review

Authentication: bearer token

Required route scopes: admin

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

Name	Location	Required	Description
`id`	path	Yes

Full parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body · required

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "decision",
          "tree_sha256"
        ],
        "properties": {
          "decision": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "approved"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "revoked"
                ]
              }
            ]
          },
          "tree_sha256": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "decision",
            "tree_sha256"
          ],
          "properties": {
            "decision": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "approved"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "revoked"
                  ]
                }
              ]
            },
            "tree_sha256": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

POST /api/v1/extensions/versions/{id}/reinspect

Authentication: bearer token

Required route scopes: admin

All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.

Name	Location	Required	Description
`id`	path	Yes

Full parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

No request body declared.

Documented responses

OpenAPI JSON

{
  "200": {
    "description": "Default Response"
  },
  "default": {
    "description": "HTTP error envelope. The status and error.code identify the failure.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Error"
        }
      }
    }
  }
}

At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.

Complete operation definition

OpenAPI JSON

{
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Native API reference