{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Software Source API", "version": "20220901" }, "items": [ { "info": { "name": "softwareSource", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of Entitlements", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/entitlements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment." }, { "name": "csi", "value": "", "type": "query", "description": "A filter to return entitlements that match the given customer support identifier (CSI)." }, { "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": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort entitlements by. Only one sort order may be provided.\n" } ] }, "docs": "Lists entitlements in the specified tenancy [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a variety of criteria including but \nnot limited to its Customer Support Identifier (CSI), and vendor name.\n" }, { "info": { "name": "Creates an entitlement with OS Management Hub.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/entitlements", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.\n" }, { "info": { "name": "Gets a list of the current errata", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/errata", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment." }, { "name": "name", "value": "", "type": "query", "description": "The assigned erratum name. It's unique and not changeable.\n\nExample: `ELSA-2020-5804`\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the erratum name given." }, { "name": "classificationType", "value": "", "type": "query", "description": "A filter to return only packages that match the given update classification type." }, { "name": "advisoryType", "value": "", "type": "query", "description": "A filter to return only errata that match the given advisory types." }, { "name": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "advisorySeverity", "value": "", "type": "query", "description": "The advisory severity.\n" }, { "name": "timeIssueDateStart", "value": "", "type": "query", "description": "The issue date after which to list all errata, in ISO 8601 format\n\nExample: 2017-07-14T02:40:00.000Z\n" }, { "name": "timeIssueDateEnd", "value": "", "type": "query", "description": "The issue date before which to list all errata, in ISO 8601 format\n\nExample: 2017-07-14T02:40:00.000Z\n" }, { "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 errata by. Only one sort order may be provided. Default order for timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default.\n" } ] }, "docs": "Lists all of the currently available errata. Filter the list against a variety of criteria including but not \nlimited to its name, classification type, advisory severity, and OS family.\n" }, { "info": { "name": "Gets an erratum by its advisory name.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/errata/:name", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment." }, { "name": "name", "value": "", "type": "path", "description": "The erratum name (such as ELSA-2023-34678)." } ] }, "docs": "Returns information about the specified erratum based on its advisory name.\n" }, { "info": { "name": "Lists Software Packages", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwarePackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "version", "value": "", "type": "query", "description": "A filter to return software packages that match the given version." }, { "name": "architecture", "value": "", "type": "query", "description": "A filter to return software packages that match the given architecture." }, { "name": "isLatest", "value": "", "type": "query", "description": "Indicates whether to list only the latest versions of packages, module streams, and stream profiles." }, { "name": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "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 packages by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.\n" } ] }, "docs": "Lists software packages available through the OS Management Hub service. Filter the list against a variety of criteria \nincluding but not limited to its name.\n" }, { "info": { "name": "Gets a software package by its fully qualified name", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwarePackages/:softwarePackageName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwarePackageName", "value": "", "type": "path", "description": "The name of the software package." } ] }, "docs": "Returns information about the specified software package based on its fully qualified name (NVRA or NEVRA)." }, { "info": { "name": "Gets a list of all software sources for a given software package", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwarePackages/:softwarePackageName/softwareSources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwarePackageName", "value": "", "type": "path", "description": "The name of the software package." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment." }, { "name": "softwareSourceType", "value": "", "type": "query", "description": "The type of the software source." }, { "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 instances whose architecture type matches the given architecture." }, { "name": "availability", "value": "", "type": "query", "description": "The availability of the software source in a non-OCI environment for a tenancy." }, { "name": "availabilityAtOci", "value": "", "type": "query", "description": "The availability of the software source in an OCI environment for a tenancy." }, { "name": "availabilityAnywhere", "value": "", "type": "query", "description": "The availability of the software source. Use this query parameter to filter across availabilities in different environments." }, { "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.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only software sources whose state matches the given state." } ] }, "docs": "Lists the software sources in the tenancy that contain the software package. Filter the list against a\nvariety of criteria including but not limited to its name, type, architecture, and OS family.\n" }, { "info": { "name": "Retrieve a list of module streams from a list of software sources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSourceModuleStreams/actions/search", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of module streams from the specified software sources. Filter the list against a variety of \ncriteria including the module name.\n" }, { "info": { "name": "Retrieve a list of modules from a list of software sources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSourceModules/actions/search", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists modules from a list of software sources. Filter the list against a variety of \ncriteria including the module name.\n" }, { "info": { "name": "Retrieve a list of package groups from a list of software sources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSourcePackageGroups/actions/search", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria \nincluding but not limited to its name, and group type.\n" }, { "info": { "name": "Gets a list of the available SoftwareSourceVendors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSourceVendors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment." }, { "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 software source vendors by. Only one sort order may be provided. Default order for name is ascending.\n" }, { "name": "name", "value": "", "type": "query", "description": "The name of the entity to be queried." } ] }, "docs": "Lists available software source vendors. Filter the list against a variety of criteria including but not limited\nto its name.\n" }, { "info": { "name": "Gets a list of all software sources", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources", "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": "softwareSourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the software source." }, { "name": "softwareSourceType", "value": "", "type": "query", "description": "The type of the software source." }, { "name": "vendorName", "value": "", "type": "query", "description": "A filter to return only resources that match the given vendor name." }, { "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 instances whose architecture type matches the given architecture." }, { "name": "availability", "value": "", "type": "query", "description": "The availability of the software source in a non-OCI environment for a tenancy." }, { "name": "availabilityAtOci", "value": "", "type": "query", "description": "The availability of the software source in an OCI environment for a tenancy." }, { "name": "availabilityAnywhere", "value": "", "type": "query", "description": "The availability of the software source. Use this query parameter to filter across availabilities in different environments." }, { "name": "isMandatoryForAutonomousLinux", "value": "", "type": "query", "description": "Indicates whether the software source is mandatory for the Autonomous Linux service." }, { "name": "isMirrorSyncAllowed", "value": "", "type": "query", "description": "A filter to return software sources which can be synced to a 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": "displayNameNotEqualTo", "value": "", "type": "query", "description": "A multi filter to return resources that do not contains the given display names." }, { "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": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only software sources whose state matches the given state." } ] }, "docs": "Lists software sources that match the specified tenancy or software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a\nvariety of criteria including but not limited to its name, status, architecture, and OS family.\n" }, { "info": { "name": "Creates a new software source.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new software source.\n" }, { "info": { "name": "Retrieves a list of available vendor software source repos to add to a specified compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/actions/availableSoftwareSources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment." }, { "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 instances whose architecture type matches the given architecture." }, { "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.\n" } ] }, "docs": "Retrieves a list of software source repos that are available to add to a specified compartment. This API returns repos that are not already selected in the specified compartment.\n" }, { "info": { "name": "Updates the availability of a list of software sources", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/actions/changeAvailability", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the availability for a list of specified software sources.\n" }, { "info": { "name": "Gets a software source by identifier", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Returns information about the specified software source." }, { "info": { "name": "Update the custom software source identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified software source's details, including but not limited to name, description, and tags.\n" }, { "info": { "name": "Delete a provisioned SoftwareSource", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Deletes the specified software source." }, { "info": { "name": "Adds packages to a software source.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/actions/addPackages", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Adds packages to a software source. This operation can only be done for custom and versioned custom software sources that are not created using filters. \nFor a versioned custom software source, you can only add packages when the source is created. Once content is added to a versioned custom software source, it is immutable.\nPackages can be of the format:\n * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of th" }, { "info": { "name": "Moves a Software Source into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Moves the specified software sources to a different compartment within the same tenancy.\nFor information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Regenerates metadata for the specified custom software source.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/actions/generateMetadata", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Regenerates metadata for the specified custom software source." }, { "info": { "name": "Removes packages from a software source.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/actions/removePackages", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Removes packages from a software source. This operation can only be done for custom software sources that are not created using filters.\nPackages can be of the format:\n * name (for example: git). This removes all versions of the package.\n * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)\n * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)\n" }, { "info": { "name": "Replaces packages in a software source with the provided list of packages.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/actions/replacePackages", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Replaces packages in a software source with the provided list of packages. This operation can only be done for custom software sources that are not created using filters.\nPackages can be of the format:\n * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added.\n * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)\n * name-epoch:version-release.architecture (for exam" }, { "info": { "name": "Lists software packages that are available to be added to a custom software source of type MANIFEST.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/availableSoftwarePackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "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": "isLatest", "value": "", "type": "query", "description": "Indicates whether to list only the latest versions of packages, module streams, and stream profiles." }, { "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 software packages that are available to be added to a custom software source of type MANIFEST. Filter the list against a variety of criteria \nincluding but not limited to its name.\n" }, { "info": { "name": "Returns an archive containing the list of packages in the software source.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/manifest", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ] }, "docs": "Returns an archive containing the list of packages in the software source.\n" }, { "info": { "name": "Updates the package manifest file for the software source.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/manifest", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the package list document for the software source.\n" }, { "info": { "name": "Retrieve a list of module stream profiles from a software source.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/moduleStreamProfiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "name": "moduleName", "value": "", "type": "query", "description": "The name of a module. This parameter is required if a\nstreamName is specified.\n" }, { "name": "streamName", "value": "", "type": "query", "description": "The name of the module stream. This parameter is required if a profile name is specified." }, { "name": "name", "value": "", "type": "query", "description": "The name of the entity to be queried." }, { "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 moduleName is ascending.\n" } ] }, "docs": "Lists module stream profiles from the specified software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a variety of \ncriteria including but not limited to its module name, stream name, and profile name.\n" }, { "info": { "name": "Retrieve a detailed description of a module stream profile from a software source.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/moduleStreamProfiles/:profileName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "name": "profileName", "value": "", "type": "path", "description": "The name of the module stream profile." }, { "name": "moduleName", "value": "", "type": "query", "description": "The name of a module.\n" }, { "name": "streamName", "value": "", "type": "query", "description": "The name of the stream of the containing module.\n" } ] }, "docs": "Returns information about the specified module stream profile in a software source.\n" }, { "info": { "name": "Retrieve a list of module streams from a software source.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/moduleStreams", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "name": "moduleName", "value": "", "type": "query", "description": "The name of a module. This parameter is required if a\nstreamName is specified.\n" }, { "name": "name", "value": "", "type": "query", "description": "The name of the entity to be queried." }, { "name": "isLatest", "value": "", "type": "query", "description": "Indicates whether to list only the latest versions of packages, module streams, and stream profiles." }, { "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 moduleName is ascending.\n" }, { "name": "moduleNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the module name given." } ] }, "docs": "Lists module streams from the specified software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). \nFilter the list against a variety of criteria including but not limited to its module name and (stream) name.\n" }, { "info": { "name": "Retrieve a detailed description of a module streams from a software source.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/moduleStreams/:moduleName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "name": "moduleName", "value": "", "type": "path", "description": "The name of the module." }, { "name": "streamName", "value": "", "type": "query", "description": "The name of the stream of the containing module.\n" } ] }, "docs": "Returns information about the specified module stream in a software source.\n" }, { "info": { "name": "Gets a list of all Package Groups associated with this vendor software source", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/packageGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "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": "name", "value": "", "type": "query", "description": "The name of the entity to be queried." }, { "name": "nameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the name given." }, { "name": "groupType", "value": "", "type": "query", "description": "A filter to return only package groups of the specified type." }, { "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 package groups that are associated with the specified software source [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a\nvariety of criteria including but not limited to its name, and package group type.\n" }, { "info": { "name": "Retrieve a Package Group from a software source.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/packageGroups/:packageGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "name": "packageGroupId", "value": "", "type": "path", "description": "The unique package group identifier." } ] }, "docs": "Returns information about the specified package group from a software source.\n" }, { "info": { "name": "Lists Software Packages", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/softwarePackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "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": "isLatest", "value": "", "type": "query", "description": "Indicates whether to list only the latest versions of packages, module streams, and stream profiles." }, { "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 software packages in the specified software source. Filter the list against a variety of criteria \nincluding but not limited to its name.\n" }, { "info": { "name": "Gets a Software Package by identifier", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/softwareSources/:softwareSourceId/softwarePackages/:softwarePackageName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "softwareSourceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source." }, { "name": "softwarePackageName", "value": "", "type": "path", "description": "The name of the software package." } ] }, "docs": "Returns information about the specified software package.\n" } ] } ], "bundled": true }