{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Management Station API", "version": "20220901" }, "items": [ { "info": { "name": "managementStation", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all ManagementStations in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managementStations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given user-friendly name." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns information for management stations in the specified state." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "location", "value": "", "type": "query", "description": "A filter to return only resources whose location matches the given value." }, { "name": "locationNotEqualTo", "value": "", "type": "query", "description": "A filter to return only resources whose location does not match the given value." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station. A filter that returns information about the specified management station." }, { "name": "healthState", "value": "", "type": "query", "description": "A filter that returns information for management stations in the specified health state." } ] }, "docs": "Lists management stations within the specified compartment. Filter the list against a variety of criteria \nincluding but not limited to name, status, and location.\n" }, { "info": { "name": "Creates a new management station", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managementStations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a management station using the proxy and mirror configuration information provided.\n" }, { "info": { "name": "Gets a ManagementStation", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ] }, "docs": "Returns information about the specified management station.\n" }, { "info": { "name": "Update the Management Station identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of the specified management station.\n" }, { "info": { "name": "Delete a Management Station", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ] }, "docs": "Deletes a management station. You can't delete a station if there are resources associated with the station \n(such as instances using the station or profiles associated with the station). Switch stations and edit profiles\nas needed before deleting the station.\n" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ] }, "docs": "Moves a managment station to a different compartment." }, { "info": { "name": "Refresh config of Management Station", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId/actions/refresh", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ] }, "docs": "Refreshes the list of software sources mirrored by the management station.\n" }, { "info": { "name": "Synchronize the specified mirrors associated with the management station", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId/actions/synchronizeMirrors", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Synchronize the specified software sources mirrored on the management station.\n" }, { "info": { "name": "Gets a list of all Mirrors associated with the corresponding ManagementStation ID", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId/mirrors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given user-friendly name." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" }, { "name": "mirrorStates", "value": "", "type": "query", "description": "List of Mirror state to filter by" } ] }, "docs": "Lists all software source mirrors associated with a specified management station.\n" }, { "info": { "name": "Synchronize a single mirror", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId/mirrors/:mirrorId/actions/synchronize", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." }, { "name": "mirrorId", "value": "", "type": "path", "description": "Unique Software Source identifier" } ] }, "docs": "Synchronize the specified software source mirrors on the management station.\n" } ] } ], "bundled": true }