{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ignition Gateway REST access-control config-databases API",
    "version": "8.3.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Ignition-API-Token",
      "value": "{{X-Ignition-API-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "config-databases",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get JDBC Driver Data File",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/datafile/ignition/database-driver/:name/:filename",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "filename",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to read the file from"
              }
            ]
          },
          "docs": "Retrieve a data file from a specific JDBC Driver resource"
        },
        {
          "info": {
            "name": "Update JDBC Driver Data File",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/datafile/ignition/database-driver/:name/:filename",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "filename",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to update. If omitted, the active definition's collection will be used."
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "(Required) The current signature of the resource."
              },
              {
                "name": "rename",
                "value": "",
                "type": "query",
                "description": "An optional new name for the file"
              }
            ]
          },
          "docs": "Update (overwrite) a data file for a named JDBC Driver resource"
        },
        {
          "info": {
            "name": "Delete JDBC Driver Data File",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/datafile/ignition/database-driver/:name/:filename",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "filename",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to update. If omitted, the active definition's collection will be used."
              },
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "(Required) The current signature of the resource."
              }
            ]
          },
          "docs": "Delete a data file for a named JDBC Driver resource"
        },
        {
          "info": {
            "name": "Delete Database Connection (multiple)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/delete/ignition/database-connection",
            "params": [
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion, required when the operation would affect other resources."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete multiple Database Connection resources by name"
        },
        {
          "info": {
            "name": "Delete JDBC Driver (multiple)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/delete/ignition/database-driver",
            "params": [
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion, required when the operation would affect other resources."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete multiple JDBC Driver resources by name"
        },
        {
          "info": {
            "name": "Delete Database Translator (multiple)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/delete/ignition/database-translator",
            "params": [
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion, required when the operation would affect other resources."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete multiple Database Translator resources by name"
        },
        {
          "info": {
            "name": "Get Database Connection Config",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/find/ignition/database-connection/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to read the resource from"
              }
            ]
          },
          "docs": "Retrieve configuration details about a specific Database Connection resource"
        },
        {
          "info": {
            "name": "Get JDBC Driver Config",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/find/ignition/database-driver/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to read the resource from"
              }
            ]
          },
          "docs": "Retrieve configuration details about a specific JDBC Driver resource"
        },
        {
          "info": {
            "name": "Get Database Translator Config",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/find/ignition/database-translator/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to read the resource from"
              }
            ]
          },
          "docs": "Retrieve configuration details about a specific Database Translator resource"
        },
        {
          "info": {
            "name": "Create Database Connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-connection",
            "params": [
              {
                "name": "allowInvalidReferences",
                "value": "",
                "type": "query",
                "description": "If true, invalid references will be allowed. Default is false."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Database Connection resource"
        },
        {
          "info": {
            "name": "Modify Database Connection",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-connection",
            "params": [
              {
                "name": "allowInvalidReferences",
                "value": "",
                "type": "query",
                "description": "If true, invalid references will be allowed. Default is false."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify one or more Database Connection resources"
        },
        {
          "info": {
            "name": "Delete Database Connection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-connection/:name/:signature",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "signature",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to delete the resource from"
              },
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion, required when the operation would affect other resources."
              }
            ]
          },
          "docs": "Delete a Database Connection resource by name"
        },
        {
          "info": {
            "name": "Create JDBC Driver",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-driver",
            "params": [
              {
                "name": "allowInvalidReferences",
                "value": "",
                "type": "query",
                "description": "If true, invalid references will be allowed. Default is false."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new JDBC Driver resource"
        },
        {
          "info": {
            "name": "Modify JDBC Driver",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-driver",
            "params": [
              {
                "name": "allowInvalidReferences",
                "value": "",
                "type": "query",
                "description": "If true, invalid references will be allowed. Default is false."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify one or more JDBC Driver resources"
        },
        {
          "info": {
            "name": "Delete JDBC Driver",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-driver/:name/:signature",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "signature",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to delete the resource from"
              },
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion, required when the operation would affect other resources."
              }
            ]
          },
          "docs": "Delete a JDBC Driver resource by name"
        },
        {
          "info": {
            "name": "Create Database Translator",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-translator",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Database Translator resource"
        },
        {
          "info": {
            "name": "Modify Database Translator",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-translator",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modify one or more Database Translator resources"
        },
        {
          "info": {
            "name": "Delete Database Translator",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/ignition/database-translator/:name/:signature",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "signature",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to delete the resource from"
              },
              {
                "name": "confirm",
                "value": "",
                "type": "query",
                "description": "Whether to confirm the deletion, required when the operation would affect other resources."
              }
            ]
          },
          "docs": "Delete a Database Translator resource by name"
        },
        {
          "info": {
            "name": "List Database Connection Resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/list/ignition/database-connection",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all Database Connection resources, in verbose format, including configuration, metrics, and health checks."
        },
        {
          "info": {
            "name": "List JDBC Driver Resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/list/ignition/database-driver",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all JDBC Driver resources, in verbose format, including configuration, metrics, and health checks."
        },
        {
          "info": {
            "name": "List Database Translator Resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/list/ignition/database-translator",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all Database Translator resources, in verbose format, including configuration, metrics, and health checks."
        },
        {
          "info": {
            "name": "Get Database Connection Names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/names/ignition/database-connection",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all Database Connection resources, including just names and enabled bit"
        },
        {
          "info": {
            "name": "Get JDBC Driver Names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/names/ignition/database-driver",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all JDBC Driver resources, including just names and enabled bit"
        },
        {
          "info": {
            "name": "Get Database Translator Names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/names/ignition/database-translator",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of items to skip before returning results."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The name of a field to sort by. Use `asc(fieldName)` or `desc(fieldName)`\nto specify the sort direction as ascending or descending, respectively.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A search string to filter items by. Terms separated by whitespace."
              },
              {
                "name": "key_0",
                "value": "",
                "type": "query",
                "description": "Filter items by field name, using format like `fieldName[op]=value` where `op` is one of: `eq` (equals), `ne` (not equals), `cn` (contains), `sw` (starts with), `ew` (ends with), `gt` (greater than), `gte` (greater than or equal), `lt` (less than), `lte` (less than or equal), `rgx` (regular expression)."
              }
            ]
          },
          "docs": "List all Database Translator resources, including just names and enabled bit"
        },
        {
          "info": {
            "name": "Rename Database Connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/rename/ignition/database-connection/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to rename the resource in"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Change the name of a Database Connection resource, and update all references to it"
        },
        {
          "info": {
            "name": "Rename JDBC Driver",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/rename/ignition/database-driver/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to rename the resource in"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Change the name of a JDBC Driver resource, and update all references to it"
        },
        {
          "info": {
            "name": "Rename Database Translator",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/rename/ignition/database-translator/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path"
              },
              {
                "name": "collection",
                "value": "",
                "type": "query",
                "description": "The configuration collection to rename the resource in"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Change the name of a Database Translator resource, and update all references to it"
        },
        {
          "info": {
            "name": "Describe 'Database Connection' Resource Type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/type/ignition/database-connection"
          },
          "docs": "Describe the Database Connection resource type"
        },
        {
          "info": {
            "name": "Describe 'JDBC Driver' Resource Type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/type/ignition/database-driver"
          },
          "docs": "Describe the JDBC Driver resource type"
        },
        {
          "info": {
            "name": "Describe 'Database Translator' Resource Type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{gateway-host}:{port}/data/api/v1/resources/type/ignition/database-translator"
          },
          "docs": "Describe the Database Translator resource type"
        }
      ]
    }
  ],
  "bundled": true
}