{ "opencollection": "1.0.0", "info": { "name": "Container Images Artifacts API", "version": "20160918" }, "items": [ { "info": { "name": "artifacts", "type": "folder" }, "items": [ { "info": { "name": "GetContainerConfiguration", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/configuration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." } ] }, "docs": "Get container configuration." }, { "info": { "name": "UpdateContainerConfiguration", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/container/configuration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update container configuration." }, { "info": { "name": "ListContainerImageSignatures", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/imageSignatures", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "imageId", "value": "", "type": "query", "description": "A filter to return a container image summary only for the specified container image OCID.\n" }, { "name": "repositoryId", "value": "", "type": "query", "description": "A filter to return container images only for the specified container repository OCID.\n" }, { "name": "repositoryName", "value": "", "type": "query", "description": "A filter to return container images or container image signatures that match the repository name.\n\nExample: `foo` or `foo*`\n" }, { "name": "imageDigest", "value": "", "type": "query", "description": "The digest of the container image.\n\nExample: `sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "kmsKeyId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the kmsKeyVersionId used to sign the container image.\n\nExample: `ocid1.keyversion.oc1..exampleuniqueID`\n" }, { "name": "kmsKeyVersionId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the kmsKeyVersionId used to sign the container image.\n\nExample: `ocid1.keyversion.oc1..exampleuniqueID`\n" }, { "name": "signingAlgorithm", "value": "", "type": "query", "description": "The algorithm to be used for signing. These are the only supported signing algorithms for container images." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[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\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "List container image signatures in an image." }, { "info": { "name": "CreateContainerImageSignature", "type": "http" }, "http": { "method": "POST", "url": "/20160918/container/imageSignatures", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a signature to an image." }, { "info": { "name": "GetContainerImageSignature", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/imageSignatures/:imageSignatureId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "imageSignatureId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n" } ] }, "docs": "Get container image signature metadata." }, { "info": { "name": "Updates properties of container image signatures", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/container/imageSignatures/:imageSignatureId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "imageSignatureId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the properties of a container image signature. Avoid entering confidential information." }, { "info": { "name": "DeleteContainerImageSignature", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/container/imageSignatures/:imageSignatureId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "imageSignatureId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n" } ] }, "docs": "Delete a container image signature." }, { "info": { "name": "ListContainerImages", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/images", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "imageId", "value": "", "type": "query", "description": "A filter to return a container image summary only for the specified container image OCID.\n" }, { "name": "isVersioned", "value": "", "type": "query", "description": "A filter to return container images based on whether there are any associated versions.\n" }, { "name": "repositoryId", "value": "", "type": "query", "description": "A filter to return container images only for the specified container repository OCID.\n" }, { "name": "repositoryName", "value": "", "type": "query", "description": "A filter to return container images or container image signatures that match the repository name.\n\nExample: `foo` or `foo*`\n" }, { "name": "version", "value": "", "type": "query", "description": "A filter to return container images that match the version.\n\nExample: `foo` or `foo*`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, { "name": "imageDigest", "value": "", "type": "query", "description": "The digest of the container image.\n\nExample: `sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[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\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "List container images in a compartment." }, { "info": { "name": "LookupContainerImageByUri", "type": "http" }, "http": { "method": "POST", "url": "/20160918/container/images/actions/lookupImageByUri", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get container image metadata by URI." }, { "info": { "name": "GetContainerImage", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/images/:imageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n" } ] }, "docs": "Get container image metadata." }, { "info": { "name": "Updates properties of container images", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/container/images/:imageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the properties of a container image. Avoid entering confidential information." }, { "info": { "name": "DeleteContainerImage", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/container/images/:imageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n" } ] }, "docs": "Delete a container image." }, { "info": { "name": "RemoveContainerVersion", "type": "http" }, "http": { "method": "POST", "url": "/20160918/container/images/:imageId/actions/removeVersion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove version from container image." }, { "info": { "name": "RestoreContainerImage", "type": "http" }, "http": { "method": "POST", "url": "/20160918/container/images/:imageId/actions/restore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "imageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore a container image." }, { "info": { "name": "ListContainerRepositories", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/repositories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "repositoryId", "value": "", "type": "query", "description": "A filter to return container images only for the specified container repository OCID.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "isPublic", "value": "", "type": "query", "description": "A filter to return resources that match the isPublic value.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[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\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "List container repositories in a compartment." }, { "info": { "name": "CreateContainerRepository", "type": "http" }, "http": { "method": "POST", "url": "/20160918/container/repositories", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new empty container repository. Avoid entering confidential information." }, { "info": { "name": "GetContainerRepository", "type": "http" }, "http": { "method": "GET", "url": "/20160918/container/repositories/:repositoryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n" } ] }, "docs": "Get container repository." }, { "info": { "name": "UpdateContainerRepository", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/container/repositories/:repositoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the properties of a container repository. Avoid entering confidential information." }, { "info": { "name": "DeleteContainerRepository", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/container/repositories/:repositoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n" } ] }, "docs": "Delete container repository." }, { "info": { "name": "ChangeContainerRepositoryCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/container/repositories/:repositoryId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a container repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListGenericArtifacts", "type": "http" }, "http": { "method": "GET", "url": "/20160918/generic/artifacts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "repositoryId", "value": "", "type": "query", "description": "A filter to return the artifacts only for the specified repository OCID.\n" }, { "name": "id", "value": "", "type": "query", "description": "A filter to return the resources for the specified OCID.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "artifactPath", "value": "", "type": "query", "description": "Filter results by a prefix for the `artifactPath` and and return artifacts that begin with the specified prefix in their path.\n" }, { "name": "version", "value": "", "type": "query", "description": "Filter results by a prefix for `version` and return artifacts that that begin with the specified prefix in their version.\n" }, { "name": "sha256", "value": "", "type": "query", "description": "Filter results by a specified SHA256 digest for the artifact.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[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\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists artifacts in the specified repository." }, { "info": { "name": "GetGenericArtifact", "type": "http" }, "http": { "method": "GET", "url": "/20160918/generic/artifacts/:artifactId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n" } ] }, "docs": "Gets information about an artifact with a specified [OCID](/iaas/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "UpdateGenericArtifact", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/generic/artifacts/:artifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the artifact with the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can only update the tags of an artifact." }, { "info": { "name": "DeleteGenericArtifact", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/generic/artifacts/:artifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "artifactId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n" } ] }, "docs": "Deletes an artifact with a specified [OCID](/iaas/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "GetGenericArtifactByPath", "type": "http" }, "http": { "method": "GET", "url": "/20160918/generic/repositories/:repositoryId/artifactPaths/:artifactPath/versions/:version", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" }, { "name": "artifactPath", "value": "", "type": "path", "description": "A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n" }, { "name": "version", "value": "", "type": "path", "description": "A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n" } ] }, "docs": "Gets information about an artifact with a specified `artifactPath` and `version`." }, { "info": { "name": "UpdateGenericArtifactByPath", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/generic/repositories/:repositoryId/artifactPaths/:artifactPath/versions/:version", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" }, { "name": "artifactPath", "value": "", "type": "path", "description": "A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n" }, { "name": "version", "value": "", "type": "path", "description": "A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an artifact with a specified `artifactPath` and `version`. You can only update the tags of an artifact." }, { "info": { "name": "DeleteGenericArtifactByPath", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/generic/repositories/:repositoryId/artifactPaths/:artifactPath/versions/:version", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" }, { "name": "artifactPath", "value": "", "type": "path", "description": "A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n" }, { "name": "version", "value": "", "type": "path", "description": "A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n" } ] }, "docs": "Deletes an artifact with a specified `artifactPath` and `version`." }, { "info": { "name": "ListRepositories", "type": "http" }, "http": { "method": "GET", "url": "/20160918/repositories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return the resources for the specified OCID.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "isImmutable", "value": "", "type": "query", "description": "A filter to return resources that match the isImmutable value.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[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\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists repositories in the specified compartment." }, { "info": { "name": "CreateRepository", "type": "http" }, "http": { "method": "POST", "url": "/20160918/repositories", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new repository for storing artifacts." }, { "info": { "name": "GetRepository", "type": "http" }, "http": { "method": "GET", "url": "/20160918/repositories/:repositoryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" } ] }, "docs": "Gets the specified repository's information." }, { "info": { "name": "UpdateRepository", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/repositories/:repositoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a repository. You can update the `displayName` and `description` properties." }, { "info": { "name": "DeleteRepository", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/repositories/:repositoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" } ] }, "docs": "Deletes the specified repository. This operation fails unless all associated artifacts are in a DELETED state. You must delete all associated artifacts before deleting a repository." }, { "info": { "name": "ChangeRepositoryCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/repositories/:repositoryId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" } ] } ], "bundled": true }