system.config
API Endpoint Considerations
The table below lists various Gateway resource configuration OpenAPI endpoints that should be called responsibly, as failing to do so may result in issues with your Gateway.
See the API Documentation page for information on viewing API docs.
| URL Endpoint | Reason |
|---|---|
| /openapi#tag/logging | Frequently dumping all logs can cause system instability due to increased memory usage. |
| /openapi#tag/thread-diagnostics | When called, the JVM will be paused to perform the thread dump. |
| /openapi#tag/config-management/paths/~1data~1api~1v1~1scan-lock~1config/post | Updates to Gateway resources will be prevented until either a timeout occurs, or a Gateway configuration scan is performed. |
| /openapi#tag/config-management/paths/~1data~1api~1v1~1scan-lock~1projects/post | Updates to projects will be prevented until either a timeout occurs, or a project scan is performed. |
| /openapi#tag/config-management/paths/~1data~1api~1v1~1scan~1config/post | Prompts the system to scan the file system for configuration changes, and releases the config scan lock if applicable. This should typically never be used in a production environment. |
| /openapi#tag/config-management/paths/~1data~1api~1v1~1scan~1projects/post | Prompts the system to scan the file system for project changes, and releases the project scan lock if applicable. This should typically never be used in a production environment, and can cause problems saving projects from the Designer. |
| /openapi#tag/restart-tasks/paths/~1data~1api~1v1~1restart-tasks~1restart/post | Restarts the Gateway, which can be highly destructive if called improperly. |
| /openapi#tag/thread-diagnostics/paths/~1data~1api~1v1~1diagnostics~1bundle~1generate/post | Creates a thread dump and consolidates logs, which can cause system instability due to increased memory usage. |
Config Functions
The following functions allow you to configure various aspects of your Gateway configuration.
📄️ copy
Copies a resource to a new name and/or collection. When using this function, either the newName or newCollection parameter must be defined.
📄️ create
Creates a new resource of the specified type.
📄️ delete
Deletes a resource of the specified type.
📄️ getActiveMode
Returns the currently active resource collection mode, or None if no mode is explicitly active.
📄️ getModes
Returns a list of all available resource collection modes.
📄️ getResource
Returns a single resource.
📄️ getResources
Returns all resources of the specified type.
📄️ getResourceTypes
Returns a list of all registered resource types.
📄️ move
Moves a resource to a different collection.
📄️ rename
Renames the specified resource.
📄️ replace
Replaces an existing resource completely with a new configuration.