openapi: 3.2.0 info: description: "Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n" title: OS Management Hub Onboarding API version: '20220901' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OS Management Hub API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml what: the harvested document for OS Management Hub API servers: - url: http://127.0.0.1/20220901 - url: https://127.0.0.1/20220901 tags: - name: onboarding paths: /profiles: get: description: "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" operationId: ListProfiles parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/ProfileTypeQueryParam' - $ref: '#/components/parameters/ProfileIdQueryParam' - $ref: '#/components/parameters/OsFamilyQueryParam' - $ref: '#/components/parameters/ArchTypeQueryParam' - $ref: '#/components/parameters/RegistrationTypeQueryParam' - $ref: '#/components/parameters/IsDefaultProfileQueryParam' - $ref: '#/components/parameters/IsServiceProvidedProfileQueryParam' - $ref: '#/components/parameters/MultiManagementStationQueryParam' - $ref: '#/components/parameters/MultiManagementStationNotEqualToQueryParam' - $ref: '#/components/parameters/ProfileVersionQueryParam' - $ref: '#/components/parameters/VendorNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ProfileLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ProfileSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of registration profile summary objects was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ProfileCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Profiles in a compartment tags: - onboarding x-example: 'GET 20220901/profiles?compartmentId=<compartment_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/Profile' post: description: 'Creates a registration profile. A profile defines the content applied to the instance when registering it with the service. ' operationId: CreateProfile parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The profile was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Profile' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Profile tags: - onboarding x-example: "POST 20220901/profiles\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n \"displayName\": \"example-name\",\n \"profileType\": \"SOFTWARESOURCE\",\n \"vendorName\": \"ORACLE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"registrationType\": \"OCI_LINUX\",\n \"softwareSourceIds\": [\"ocid1.osmhsoftwaresource.oc1..exampleuniqueID\"]\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProfileDetails' description: Provides the information used to create the registration profile. required: true /profiles/{profileId}: delete: description: Deletes a specified registration profile. operationId: DeleteProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The registration profile was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Profile tags: - onboarding x-example: 'DELETE 20220901/profiles/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/Profile' get: description: Returns information about the specified registration profile. operationId: GetProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The registration profile was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Profile' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Profile tags: - onboarding x-example: 'GET 20220901/profiles/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com ' put: description: Updates the specified profile's name, description, and tags. operationId: UpdateProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The registration profile was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Profile' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the profile with the given id tags: - onboarding x-example: "PUT 20220901/profiles/<resource_OCID>\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"displayName\": \"example-name\",\n \"hostname\": \"example-hostname\",\n \"isDefaultProfile\": false\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProfileDetails' description: The information to be updated. required: true /profiles/{profileId}/actions/attachLifecycleStage: post: description: 'Attaches the specified lifecycle stage to a profile. ' operationId: AttachLifecycleStageToProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The lifecycle stage was attached to the profile. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Attaches lifecycle stage to a profile tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/attachLifecycleStage\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"lifecycleStageId\": \"ocid1.osmhlifecyclestage.oc1..exampleuniqueID\"\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachLifecycleStageToProfileDetails' description: The lifecycle stage [OCID](/iaas/Content/General/Concepts/identifiers.htm) to attach to the profile required: true /profiles/{profileId}/actions/attachManagedInstanceGroup: post: description: 'Attaches the specified managed instance group to a profile. ' operationId: AttachManagedInstanceGroupToProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The managed instance group was attached to the profile. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Attaches managed instance group to a profile tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/attachManagedInstanceGroup\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"managedInstanceGroupId\": \"ocid1.osmhmanagedinstancegroup.oc1..exampleuniqueID\"\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachManagedInstanceGroupToProfileDetails' description: The managed instance group [OCID](/iaas/Content/General/Concepts/identifiers.htm) to attach to the profile required: true /profiles/{profileId}/actions/attachManagementStation: post: description: 'Attaches the specified management station to a profile. ' operationId: AttachManagementStationToProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The management station was attached to the profile. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Attaches management station to a profile tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/attachManagementStation\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"managementStationId\": \"ocid1.osmhmanagementstation.oc1..exampleuniqueID\"\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachManagementStationToProfileDetails' description: The management station [OCID](/iaas/Content/General/Concepts/identifiers.htm) to attach to the profile required: true /profiles/{profileId}/actions/attachSoftwareSources: post: description: 'Attaches the specified software sources to a profile. ' operationId: AttachSoftwareSourcesToProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The software sources were attached to the profile. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Attaches software sources to a profile tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/attachSoftwareSources\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"softwareSources\": [\"ocid1.osmhsoftwaresource.oc1..exampleuniqueID\"]\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachSoftwareSourcesToProfileDetails' description: The software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to attach to the profile required: true /profiles/{profileId}/actions/changeCompartment: post: description: Moves the profile to a different compartment. operationId: ChangeProfileCompartment parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/ChangeProfileCompartmentDetailsParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The profile's compartment was changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Change the profile compartment. tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/changeCompartment\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\"\n}\n" x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Profile' /profiles/{profileId}/actions/detachManagementStation: post: description: 'Detaches the specified management station from a profile. ' operationId: DetachManagementStationFromProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The management station was detached from the profile. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Detaches management station from a profile tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/detachManagementStation\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"managementStationId\": \"ocid1.osmhmanagementstation.oc1..exampleuniqueID\"\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachManagementStationFromProfileDetails' description: The management station [OCID](/iaas/Content/General/Concepts/identifiers.htm) to detach from the profile required: true /profiles/{profileId}/actions/detachSoftwareSources: post: description: 'Detaches the specified software sources from a profile. ' operationId: DetachSoftwareSourcesFromProfile parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The software sources were detached from the profile. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Detaches software sources from a profile tags: - onboarding x-example: "POST 20220901/profiles/<resource_OCID>/actions/detachSoftwareSources\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n\n{\n \"softwareSources\": [\"ocid1.osmhsoftwaresource.oc1..exampleuniqueID\"]\n}\n" x-related-resource: '#/definitions/Profile' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachSoftwareSourcesFromProfileDetails' description: The software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to detach from the profile required: true /profiles/{profileId}/availableSoftwareSources: get: description: '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. ' operationId: ListProfileAvailableSoftwareSources parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ProfileSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of available software sources was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AvailableSoftwareSourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 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. tags: - onboarding x-example: 'GET 20220901/profiles/<resource_OCID>/availableSoftwareSources Host: osmh.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/Profile' /profiles/{profileId}/version/{profileVersion}: get: description: Returns information about the version of the specified registration profile. operationId: GetProfileVersion parameters: - $ref: '#/components/parameters/ProfileIdentifierPathParam' - $ref: '#/components/parameters/ProfileVersionPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The registration profile was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProfileVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Profile Version tags: - onboarding x-example: 'GET 20220901/profiles/<resource_OCID>/version/<version_number> Host: osmh.us-phoenix-1.oci.oraclecloud.com ' components: parameters: PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `3` ' in: query name: page x-default-description: 'null' schema: type: string minLength: 1 OsFamilyQueryParam: description: A filter to return only resources that match the given operating system family. in: query name: osFamily x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OsFamily' schema: type: string enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 MultiDisplayNameQueryParam: description: A filter to return resources that match the given display names. in: query name: displayName x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string maxItems: 5 uniqueItems: true MultiManagementStationQueryParam: description: "A filter to return resources that are associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" in: query name: managementStation x-default-description: 'null' style: form explode: true schema: type: array items: type: string uniqueItems: true DisplayNameContainsQueryParam: description: A filter to return resources that may partially match the given display name. in: query name: displayNameContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. in: query name: compartmentId x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string RegistrationTypeQueryParam: description: A filter to return profiles that match the given instance type. in: query name: registrationType x-default-description: 'null' style: form explode: true schema: type: array items: type: string x-obmcs-enumref: '#/definitions/Profile/registrationType' uniqueItems: true ChangeProfileCompartmentDetailsParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the profile to. in: body name: ChangeProfileCompartmentDetails required: true schema: $ref: '#/components/schemas/ChangeProfileCompartmentDetails' ProfileIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. A filter used to return the specified profile. in: query name: profileId required: false x-default-description: 'null' schema: type: string IsServiceProvidedProfileQueryParam: description: 'A filter to return only service-provided profiles. ' in: query name: isServiceProvidedProfile required: false x-default-description: 'null' schema: type: boolean ProfileVersionQueryParam: description: The version of the registration profile. in: query name: profileVersion required: false x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 VendorNameQueryParam: description: A filter to return only resources that match the given vendor name. in: query name: vendorName x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/VendorName' schema: type: string enum: - ORACLE - MICROSOFT - CANONICAL SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC ProfileIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. in: path name: profileId required: true schema: type: string ProfileLifecycleStateQueryParam: description: A filter to return only registration profiles in the given state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Profile/lifecycleState' schema: type: string ProfileTypeQueryParam: description: A filter to return registration profiles that match the given profile type. in: query name: profileType x-default-description: 'null' style: form explode: true schema: type: array items: enum: - SOFTWARESOURCE - GROUP - LIFECYCLE - STATION - WINDOWS_STANDALONE - UBUNTU_STANDALONE type: string x-obmcs-top-level-enum: '#/definitions/ProfileType' uniqueItems: true RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 ProfileSortByQueryParam: 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" in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ArchTypeQueryParam: description: A filter to return only profiles that match the given archType. in: query name: archType x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ArchType' schema: type: string enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. in: header name: opc-request-id schema: type: string IsDefaultProfileQueryParam: description: 'A filter to return only default profiles. ' in: query name: isDefaultProfile required: false x-default-description: 'null' schema: type: boolean MultiManagementStationNotEqualToQueryParam: description: "A filter to return resources that aren't associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" in: query name: managementStationNotEqualTo x-default-description: 'null' style: form explode: true schema: type: array items: type: string uniqueItems: true ProfileVersionPathParam: description: The version of the registration profile. in: path name: profileVersion required: true schema: type: string schemas: Error: description: Provides the information for an error. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message AttachSoftwareSourcesToProfileDetails: description: Provides the information used to attach software sources to a profile. properties: softwareSources: description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to attach to the profile. items: type: string type: array required: - softwareSources LifecycleStageDetails: description: Provides identifying information for the specified lifecycle stage. properties: displayName: description: Lifecycle stage name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. type: string required: - id type: object AvailableSoftwareSourceSummary: description: "Provides summary information about an available software source. \nAn available software source can be added to a managed instance. \nAfter a software source is added, packages from that software source can be installed on that managed instance.\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source. type: string description: description: Software source description. type: string displayName: description: User-friendly name for the software source. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. type: string softwareSourceType: description: Type of the software source. enum: - VENDOR - CUSTOM - VERSIONED - PRIVATE - THIRD_PARTY type: string x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType' required: - displayName - id - compartmentId - softwareSourceType type: object ProfileCollection: description: 'The set of registration profiles returned for the [ListProfiles](#/en/osmh/latest/Profile/ListProfiles) operation. ' properties: items: description: List of registration profiles. items: $ref: '#/components/schemas/ProfileSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.osmhprofile.oc1..exampleuniqueID\",\n \"displayName\": \"profile-example\",\n \"description\": null,\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleuniqueID\",\n \"managementStationId\": \"ocid1.osmhmanagementstation.oc1..exampleuniqueID\",\n \"profileType\": \"STATION\",\n \"registrationType\": \"NON_OCI_LINUX\",\n \"vendorName\": \"ORACLE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"timeCreated\": \"2024-09-17T22:47:18.167Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"isDefaultProfile\": false,\n \"isServiceProvidedProfile\": false,\n \"freeformTags\": {},\n \"definedTags\": {\n \"Oracle-Tags\": {\n \"CreatedBy\": \"owner\",\n \"CreatedOn\": \"2024-09-17T22:47:18.086Z\"\n }\n },\n \"systemTags\": {}\n }\n ]\n} \n" DetachSoftwareSourcesFromProfileDetails: description: Provides the information used to detach software sources from a profile. properties: softwareSources: description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to detach from the profile. items: type: string type: array required: - softwareSources LifecycleEnvironmentDetails: description: Provides identifying information for the specified lifecycle environment. properties: displayName: description: Lifecycle environment name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. type: string required: - id type: object ProfileSummary: description: Provides summary information for a registration profile. properties: archType: description: The architecture type. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the registration profile. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified description of the registration profile. type: string displayName: description: A user-friendly name for the profile. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. type: string isDefaultProfile: default: false description: 'Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. ' type: boolean isServiceProvidedProfile: default: false description: 'Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances. ' type: boolean lifecycleState: description: The current state of the registration profile. type: string x-obmcs-enumref: '#/definitions/Profile/lifecycleState' managementStationId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate with an \ninstance once registered. Management stations are only used with non-OCI instances.\n" maxLength: 255 minLength: 1 type: string osFamily: description: The operating system family. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' profileType: description: The type of registration profile. enum: - SOFTWARESOURCE - GROUP - LIFECYCLE - STATION - WINDOWS_STANDALONE - UBUNTU_STANDALONE type: string x-obmcs-top-level-enum: '#/definitions/ProfileType' registrationType: description: The type of instance to register. type: string x-obmcs-enumref: '#/definitions/Profile/registrationType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time the registration profile was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string vendorName: description: The vendor of the operating system for the instance. enum: - ORACLE - MICROSOFT - CANONICAL type: string x-obmcs-top-level-enum: '#/definitions/VendorName' required: - id - compartmentId type: object x-example: "{\n \"id\": \"ocid1.osmhprofile.oc1..exampleuniqueID\",\n \"displayName\": \"profile-example\",\n \"description\": null,\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleuniqueID\",\n \"managementStationId\": \"ocid1.osmhmanagementstation.oc1..exampleuniqueID\",\n \"profileType\": \"STATION\",\n \"registrationType\": \"NON_OCI_LINUX\",\n \"vendorName\": \"ORACLE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"timeCreated\": \"2024-09-17T22:47:18.167Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"isDefaultProfile\": false,\n \"isServiceProvidedProfile\": false,\n \"freeformTags\": {},\n \"definedTags\": {\n \"Oracle-Tags\": {\n \"CreatedBy\": \"owner\",\n \"CreatedOn\": \"2024-09-17T22:47:18.086Z\"\n }\n },\n \"systemTags\": {}\n}\n" AttachLifecycleStageToProfileDetails: description: Provides the information used to attach a lifecycle stage to a profile. properties: lifecycleStageId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage that the instance will be associated with. maxLength: 255 minLength: 1 type: string required: - lifecycleStageId AttachManagementStationToProfileDetails: description: Provides the information used to attach a management station to a profile. properties: managementStationId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station that the instance will be associated with. maxLength: 255 minLength: 1 type: string required: - managementStationId ChangeProfileCompartmentDetails: description: Provides the information used to move a profile to another compartment. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the profile to. ' maxLength: 255 minLength: 1 type: string type: object Profile: description: Object that defines the registration profile. discriminator: propertyName: profileType properties: archType: description: The architecture type. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the registration profile. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the registration profile. type: string displayName: description: A user-friendly name for the profile. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. type: string isDefaultProfile: default: false description: 'Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. ' type: boolean isServiceProvidedProfile: default: false description: 'Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances. ' type: boolean lifecycleState: description: The current state of the registration profile. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string managementStationId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate with an \ninstance once registered. Management stations are only used by non-OCI instances.\n" type: string osFamily: description: The operating system family. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' profileType: description: The type of profile. enum: - SOFTWARESOURCE - GROUP - LIFECYCLE - STATION - WINDOWS_STANDALONE - UBUNTU_STANDALONE type: string x-obmcs-top-level-enum: '#/definitions/ProfileType' profileVersion: description: The version of the profile. The version is automatically incremented each time the profiled is edited. type: string registrationType: description: The type of instance to register. enum: - OCI_LINUX - NON_OCI_LINUX - OCI_WINDOWS - AUTONOMOUS_LINUX type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the registration profile was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string timeModified: description: The time the registration profile was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string vendorName: description: The vendor of the operating system for the instance. enum: - ORACLE - MICROSOFT - CANONICAL type: string x-obmcs-top-level-enum: '#/definitions/VendorName' required: - id - compartmentId - displayName - vendorName - osFamily - archType type: object SoftwareSourceDetails: description: Provides identifying information for the specified software source. properties: description: description: Software source description. type: string displayName: description: Software source name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. type: string isMandatoryForAutonomousLinux: description: Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. type: boolean softwareSourceType: description: Type of the software source. enum: - VENDOR - CUSTOM - VERSIONED - PRIVATE - THIRD_PARTY type: string x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType' required: - id type: object ManagedInstanceGroupDetails: description: Provides identifying information for the specified managed instance group. properties: displayName: description: Managed instance group name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. type: string required: - id type: object AttachManagedInstanceGroupToProfileDetails: description: Provides the information used to attach a managed instance group to a profile. properties: managedInstanceGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group that the instance will be associated with. maxLength: 255 minLength: 1 type: string required: - managedInstanceGroupId AvailableSoftwareSourceCollection: description: "The set of available software sources returned for the [ListManagedInstanceAvailableSoftwareSources](#/en/osmh/latest/ManagedInstance/ListManagedInstanceAvailableSoftwareSources) or the \n[ListManagedInstanceGroupAvailableSoftwareSources](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupAvailableSoftwareSources) operation.\n" properties: items: description: List of available software sources. items: $ref: '#/components/schemas/AvailableSoftwareSourceSummary' type: array required: - items type: object DetachManagementStationFromProfileDetails: description: Provides the information used to detach a management station from a profile. properties: managementStationId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station to detach from the profile. maxLength: 255 minLength: 1 type: string required: - managementStationId CreateProfileDetails: description: Provides the information used to create a new registration profile. discriminator: propertyName: profileType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the registration profile. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified description of the registration profile. maxLength: 400 minLength: 1 type: string displayName: description: "A user-friendly name. Must be unique and you can change the name later. Avoid entering \nconfidential information.\n" format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isDefaultProfile: default: false description: 'Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. ' type: boolean managementStationId: description: "description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate \nwith an instance once registered. This is used when creating a profile for non-OCI instances.\n" maxLength: 255 minLength: 1 type: string profileType: description: The type of profile. enum: - SOFTWARESOURCE - GROUP - LIFECYCLE - STATION - WINDOWS_STANDALONE - UBUNTU_STANDALONE maxLength: 255 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ProfileType' registrationType: description: The type of instance to register. maxLength: 255 minLength: 1 type: string x-obmcs-enumref: '#/definitions/Profile/registrationType' required: - displayName - compartmentId - profileType type: object UpdateProfileDetails: description: Provides the information used to update a registration profile. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified description of the profile. maxLength: 400 type: string displayName: description: A user-friendly name for the profile. Does not have to be unique. Avoid entering confidential information. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isDefaultProfile: default: false description: 'Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. ' type: boolean type: object ProfileVersion: description: Represents a specific version of a registration profile. properties: archType: description: The architecture type. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the registration profile. type: string description: description: The description of the registration profile. type: string displayName: description: A user-friendly name for the profile. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. type: string isDefaultProfile: default: false description: 'Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. ' type: boolean isServiceProvidedProfile: default: false description: 'Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances. ' type: boolean lifecycleEnvironment: $ref: '#/components/schemas/LifecycleEnvironmentDetails' lifecycleStage: $ref: '#/components/schemas/LifecycleStageDetails' lifecycleState: description: The current state of the registration profile. type: string x-obmcs-enumref: '#/definitions/Profile/lifecycleState' managedInstanceGroup: $ref: '#/components/schemas/ManagedInstanceGroupDetails' managementStationId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate with an \ninstance once registered. Management stations are only used with non-OCI instances.\n" type: string osFamily: description: The operating system family. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' profileType: description: The type of profile. enum: - SOFTWARESOURCE - GROUP - LIFECYCLE - STATION - WINDOWS_STANDALONE - UBUNTU_STANDALONE type: string x-obmcs-top-level-enum: '#/definitions/ProfileType' profileVersion: description: The version of the profile. type: string registrationType: description: The type of instance to register. enum: - OCI_LINUX - NON_OCI_LINUX - OCI_WINDOWS - AUTONOMOUS_LINUX type: string softwareSources: description: The list of software sources that the registration profile will use. items: $ref: '#/components/schemas/SoftwareSourceDetails' type: array timeCreated: description: The time the registration profile was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string timeModified: description: The time the registration profile was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string vendorName: description: The vendor of the operating system for the instance. enum: - ORACLE - MICROSOFT - CANONICAL type: string x-obmcs-top-level-enum: '#/definitions/VendorName' required: - id - compartmentId - displayName - vendorName - osFamily - archType type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' type: integer opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.osmh.api