{ "opencollection": "1.0.0", "info": { "name": "Delphix DCT Algorithms HyperscaleInstance API", "version": "3.28.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "HyperscaleInstance", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Hyperscale instances.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/hyperscale-instances", "params": [ { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies descending order." } ] }, "docs": "Returns a list of Hyperscale instances." }, { "info": { "name": "Register a Hyperscale instance", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances", "params": [ { "name": "validate_instance", "value": "", "type": "query", "description": "If true, validates the registering hyperscale orchestrator and identify dataType." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a Hyperscale instance" }, { "info": { "name": "Search for Hyperscale instances.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances/search", "params": [ { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies descending order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search for Hyperscale instances." }, { "info": { "name": "Returns a Hyperscale Instance by ID.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ] }, "docs": "Returns a Hyperscale Instance by ID." }, { "info": { "name": "Update an Hyperscale Instance", "type": "http" }, "http": { "method": "PATCH", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Hyperscale Instance" }, { "info": { "name": "Unregister a Hyperscale Instance.", "type": "http" }, "http": { "method": "DELETE", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ] }, "docs": "Unregister a Hyperscale Instance." }, { "info": { "name": "Get tags for a Hyperscale Instance.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/tags", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ] }, "docs": "Get tags for a Hyperscale Instance." }, { "info": { "name": "Create tags for a Hyperscale Instance.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/tags", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create tags for a Hyperscale Instance." }, { "info": { "name": "Delete tags for a Hyperscale Instance.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/tags/delete", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete tags for a Hyperscale Instance." }, { "info": { "name": "Sync the global object from a source engine to engines on a Hyperscale Instance.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/sync-engines", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sync the global object from a source engine to engines on a Hyperscale Instance." }, { "info": { "name": "Add an engine to a Hyperscale Instance.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/add-engine", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an engine to a Hyperscale Instance." }, { "info": { "name": "Remove an engine from a Hyperscale Instance.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/remove-engine", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove an engine from a Hyperscale Instance." }, { "info": { "name": "Move compliance nodes from a hyperscale orchestrator to a job orchestrator.", "type": "http" }, "http": { "method": "PUT", "url": "/dct/v3/hyperscale-instances/:hyperscaleInstanceId/move-to-job-orchestrator", "params": [ { "name": "hyperscaleInstanceId", "value": "", "type": "path", "description": "The ID of hyperscale instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move compliance nodes from a hyperscale orchestrator to a job orchestrator." } ] } ], "bundled": true }