{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Dynamic Set API", "version": "20220901" }, "items": [ { "info": { "name": "dynamicSet", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all dynamic sets in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/dynamicSets", "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": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given user-friendly name." }, { "name": "dynamicSetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." }, { "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.\n" } ] }, "docs": "Lists dynamic sets that match the specified compartment or dynamic set OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version." }, { "info": { "name": "Creates a new DynamicSet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dynamic set.\n" }, { "info": { "name": "Preview managed instances in a dynamic set", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets/actions/previewManagedInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates whether to include subcompartments in the returned results. Default is false." }, { "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.\n" }, { "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview a dynamic set" }, { "info": { "name": "Get DynamicSet", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Gets information about the specified dynamic set." }, { "info": { "name": "Update the dynamic set identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified dynamic set.\n" }, { "info": { "name": "Deletes a DynamicSet", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Deletes the specific dynamic set\n" }, { "info": { "name": "Move a Dynamic Sey into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Move the specified Dynamic Set to a different compartment" }, { "info": { "name": "Install packages on a dynamic set", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId/actions/installPackages", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Installs specified software packages on all managed instances in the dynamic set." }, { "info": { "name": "Reboot a dynamic set", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId/actions/reboot", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Initiates a reboot of all managed instances within the specified dynamic set." }, { "info": { "name": "Remove packages from a dynamic set", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId/actions/removePackages", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Removes specified software packages from all managed instances in the dynamic set." }, { "info": { "name": "Update packages on a dynamic set", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId/actions/updatePackages", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." } ] }, "docs": "Updates all installed software packages on managed instances in the dynamic set." }, { "info": { "name": "List managed instances in a dynamic set", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/dynamicSets/:dynamicSetId/managedInstances", "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates whether to include subcompartments in the returned results. Default is false." }, { "name": "dynamicSetId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given user-friendly 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.\n" } ] }, "docs": "Retrieves a list of managed instances associated with a specified dynamic set." } ] } ], "bundled": true }