{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Onboarding API", "version": "20220901" }, "items": [ { "info": { "name": "onboarding", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all Profiles in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/profiles", "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 display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "profileType", "value": "", "type": "query", "description": "A filter to return registration profiles that match the given profile type." }, { "name": "profileId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. A filter used to return the specified profile." }, { "name": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "archType", "value": "", "type": "query", "description": "A filter to return only profiles that match the given archType." }, { "name": "registrationType", "value": "", "type": "query", "description": "A filter to return profiles that match the given instance type." }, { "name": "isDefaultProfile", "value": "", "type": "query", "description": "A filter to return only default profiles.\n" }, { "name": "isServiceProvidedProfile", "value": "", "type": "query", "description": "A filter to return only service-provided profiles.\n" }, { "name": "managementStation", "value": "", "type": "query", "description": "A filter to return resources that are associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "managementStationNotEqualTo", "value": "", "type": "query", "description": "A filter to return resources that aren't associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "profileVersion", "value": "", "type": "query", "description": "The version of the registration profile." }, { "name": "vendorName", "value": "", "type": "query", "description": "A filter to return only resources that match the given vendor 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": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only registration profiles in the given state." }, { "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. \nDefault order for timeCreated is descending. \nDefault order for displayName is ascending.\n" } ] }, "docs": "Lists registration profiles that match the specified compartment or profile OCID. Filter the list against a \nvariety of criteria including but not limited to its name, status, vendor name, and architecture type.\n" }, { "info": { "name": "Creates a new Profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a registration profile. A profile defines the content applied to the instance when registering it with the service.\n" }, { "info": { "name": "Get Profile", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/profiles/:profileId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ] }, "docs": "Returns information about the specified registration profile." }, { "info": { "name": "Update the profile with the given id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/profiles/:profileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified profile's name, description, and tags." }, { "info": { "name": "Delete a provisioned Profile", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220901/profiles/:profileId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ] }, "docs": "Deletes a specified registration profile." }, { "info": { "name": "Attaches lifecycle stage to a profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/attachLifecycleStage", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified lifecycle stage to a profile.\n" }, { "info": { "name": "Attaches managed instance group to a profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/attachManagedInstanceGroup", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified managed instance group to a profile.\n" }, { "info": { "name": "Attaches management station to a profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/attachManagementStation", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified management station to a profile.\n" }, { "info": { "name": "Attaches software sources to a profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/attachSoftwareSources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified software sources to a profile.\n" }, { "info": { "name": "Change the profile compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ] }, "docs": "Moves the profile to a different compartment." }, { "info": { "name": "Detaches management station from a profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/detachManagementStation", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detaches the specified management station from a profile.\n" }, { "info": { "name": "Detaches software sources from a profile", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/profiles/:profileId/actions/detachSoftwareSources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detaches the specified software sources from a profile.\n" }, { "info": { "name": "Gets a list of all software sources available for the profile. These only include software sources that are not already added to the profile, but can be added.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/profiles/:profileId/availableSoftwareSources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "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": "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. \nDefault order for timeCreated is descending. \nDefault order for displayName is ascending.\n" } ] }, "docs": "Lists available software sources for a specified profile. Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the profile.\n" }, { "info": { "name": "Get Profile Version", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/profiles/:profileId/version/:profileVersion", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile." }, { "name": "profileVersion", "value": "", "type": "path", "description": "The version of the registration profile." } ] }, "docs": "Returns information about the version of the specified registration profile." } ] } ], "bundled": true }