{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.CurrentTask":{"type":"object","description":"Asynchronous operation currently running","properties":{"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"id":{"type":"string","description":"Identifier of the current task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the task details","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.CurrentTaskStatusEnum"}],"description":"Current global status of the current task","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the current task","readOnly":true}}},"common.CurrentTaskStatusEnum":{"type":"string","description":"Current status of a task. A task in ERROR cannot be retried without your inputs. PENDING tasks will be executed as soon as possible. A RUNNING task is currently executing your original request. SCHEDULED is used for tasks that will be executed in the future.","enum":["ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"common.Event":{"type":"object","description":"Represents an event for an async envelope","properties":{"createdAt":{"type":"string","description":"Creation date of the event","format":"date-time","readOnly":true},"kind":{"type":"string","description":"Nature of the event","readOnly":true},"link":{"type":"string","description":"Link to the event related resource","nullable":true,"readOnly":true},"message":{"type":"string","description":"Description of what happened on the event","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/common.EventTypeEnum"}],"description":"Type of the event","readOnly":true}}},"common.EventTypeEnum":{"type":"string","description":"Nature of an event","enum":["TARGET_SPEC_UPDATE","TASK_ERROR","TASK_START","TASK_SUCCESS"]},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"common.Task":{"type":"object","description":"Asynchronous operation","properties":{"createdAt":{"type":"string","description":"Creation date of the task","format":"date-time","readOnly":true},"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"finishedAt":{"type":"string","description":"Ending date of the task","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"string","description":"Unique identifier of the task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the related resource","readOnly":true},"message":{"type":"string","description":"Description of the task","readOnly":true},"progress":{"type":"array","description":"Progress steps of the asynchronous operation","items":{"$ref":"#/components/schemas/common.TaskProgress"},"readOnly":true},"startedAt":{"type":"string","description":"Starting date of the task","nullable":true,"format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current global status of the task","readOnly":true},"type":{"type":"string","description":"Type of the task","readOnly":true},"updatedAt":{"type":"string","description":"Last update of the task","format":"date-time","readOnly":true}}},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","readOnly":true}}},"common.TaskProgress":{"type":"object","description":"Detailed information about an asynchronous operation progress steps","properties":{"name":{"type":"string","description":"Progress step name","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.TaskStatusEnum"}],"description":"Current status of the progress step","readOnly":true}}},"common.TaskStatusEnum":{"type":"string","description":"Current status of a task","enum":["DONE","ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"publicCloud.managedRegistry.ArtifactStorage":{"type":"object","description":"Artifact storage usage. Storage consumed by artifacts, compared with the limit of the plan.","properties":{"limit":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.ValueWithUnit"}],"description":"Limit. Maximum artifact storage of the current plan. Reported by the service. See ValueWithUnit.","readOnly":true},"used":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.ValueWithUnit"}],"description":"Used. Artifact storage currently consumed. Null until the first measurement is collected. Reported by the service. See ValueWithUnit.","nullable":true,"readOnly":true}}},"publicCloud.managedRegistry.Authentication":{"type":"object","description":"Registry authentication. Login method of the registry. `oidc` is required if and only if `type` is `OIDC`.","properties":{"oidc":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.Oidc"}],"description":"OIDC configuration. External OpenID Connect provider users log in with. Required when `type` is `OIDC`, null otherwise. Mutable. See Oidc.","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.AuthenticationTypeEnum"}],"description":"Authentication type. Login method of the registry. Changing it deletes every existing Harbor user of the registry once the update task completes. Robot accounts are kept."}},"required":["type"]},"publicCloud.managedRegistry.AuthenticationTypeEnum":{"type":"string","description":"Authentication type. How users log in to the Harbor web interface and API of the registry. `IAM`: Users log in with OVHcloud accounts, authorized through OVHcloud IAM policies. `LOCAL`: Users log in with accounts created in Harbor. `OIDC`: Users log in through an external OpenID Connect provider. Requires `oidc`.","enum":["IAM","LOCAL","OIDC"]},"publicCloud.managedRegistry.AuthorizedIpRule":{"type":"object","description":"Authorized IP rule. CIDR block allowed on one or more scopes of the registry.","properties":{"cidr":{"allOf":[{"$ref":"#/components/schemas/ipv4Block"}],"description":"CIDR. nIPv4 block allowed, for example `192.0.2.0/24`. Mutable."},"description":{"type":"string","description":"Description. Free text describing the rule, for example `VPN`. Null when not set. Mutable.","nullable":true},"scopes":{"type":"array","description":"Scopes. Parts of the registry the CIDR block is allowed on. Mutable.","items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.AuthorizedIpRuleScopeEnum"}}},"required":["cidr","scopes"]},"publicCloud.managedRegistry.AuthorizedIpRuleScopeEnum":{"type":"string","description":"Authorized IP rule scope. Part of the registry an authorized IP rule applies to. `ADMINISTRATION`: Harbor web interface and management API. `ARTIFACT_OPERATIONS`: Registry endpoint used to push and pull artifacts, for example with `docker` or `helm`.","enum":["ADMINISTRATION","ARTIFACT_OPERATIONS"]},"publicCloud.managedRegistry.AuthorizedIps":{"type":"object","description":"Authorized IPs. IP filtering of the registry. When `rules` is empty or null, any IP is allowed on every scope. Otherwise a scope accepts only the CIDR blocks of the rules that list it.","properties":{"rules":{"type":"array","description":"Rules. CIDR blocks allowed to reach the registry, each on one or more scopes. When empty or null, any IP is allowed. The list is replaced as a whole on update. See AuthorizedIpRule.","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.AuthorizedIpRule"}}}},"publicCloud.managedRegistry.Credentials":{"type":"object","description":"Administrator credentials. Username and password of the Harbor administrator account of the registry.","properties":{"password":{"type":"string","description":"New password of the administrator account. The previous password stops working. Returned by the reset call only.","format":"password","readOnly":true},"username":{"type":"string","description":"Username of the administrator account","readOnly":true}}},"publicCloud.managedRegistry.Oidc":{"type":"object","description":"OpenID Connect configuration. External OpenID Connect provider configured as the Harbor login method. Used when `authentication.type` is `OIDC`. Register `<currentState.url>/c/oidc/callback` as a redirect URI of the client in the provider. Each field maps a Harbor OIDC setting, described in the [Harbor documentation](https://goharbor.io/docs/latest/administration/configure-authentication/oidc-auth/).","properties":{"adminGroup":{"type":"string","description":"Admin group. Group of the OIDC provider whose members get the Harbor system administrator role. When null, no group gets the role. Requires `groupsClaim`. Mutable.","nullable":true},"autoOnboard":{"type":"boolean","description":"Automatic onboarding. When `true`, a user logging in for the first time is created from the token claims, without the Harbor onboarding screen. When null, treated as `false`. Mutable.","nullable":true},"clientId":{"type":"string","description":"Client ID. Client identifier of the registry in the OIDC provider. Mutable."},"clientSecret":{"type":"string","description":"Client secret of the registry in the OIDC provider. Required at creation. On update, omit it to keep the current secret, or set it to replace it. Mutable. Write-only: never returned on read.","nullable":true,"format":"password"},"endpoint":{"type":"string","description":"Endpoint. Issuer URL of the OIDC provider, for example `https://keycloak.example.com/realms/mpr`. Its `/.well-known/openid-configuration` document must be reachable from the registry. Mutable."},"groupFilter":{"type":"string","description":"Group filter. Regular expression selecting the groups of `groupsClaim` that are imported into Harbor. It does not restrict who can log in. When null, every group is imported. Mutable.","nullable":true},"groupsClaim":{"type":"string","description":"Name of the token claim that lists the groups of the user. When null, groups are not read from the token. Mutable.","nullable":true},"name":{"type":"string","description":"Name of the OIDC provider, displayed on the Harbor login button. Mutable."},"scope":{"type":"string","description":"Comma-separated OIDC scopes requested at login, for example `openid,profile,email,offline_access`. Must include `openid`. Include `offline_access` so the registry gets a refresh token. Mutable."},"userClaim":{"type":"string","description":"Name of the ID token claim used as the Harbor username. The claim must be present in the ID token, otherwise onboarding the user fails. When null, Harbor uses the `name` claim. Mutable.","nullable":true},"verifyCert":{"type":"boolean","description":"Verify certificate. When `true`, the TLS certificate of `endpoint` is verified. When null, treated as `true`. Set it to `false` only for a provider with a self-signed or untrusted certificate. Mutable.","nullable":true}},"required":["clientId","endpoint","name","scope"]},"publicCloud.managedRegistry.Plan":{"type":"object","description":"Managed Private Registry plan. Plan with its limits and features, as listed by the reference and capabilities routes.","properties":{"features":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.PlanFeatures"}],"description":"Features included in the plan. See PlanFeatures.","readOnly":true},"limits":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.PlanLimits"}],"description":"Resource limits enforced by the plan. See PlanLimits.","readOnly":true},"name":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.PlanEnum"}],"description":"Name of the plan, to use as `targetSpec.plan`","readOnly":true}}},"publicCloud.managedRegistry.PlanEnum":{"type":"string","description":"Managed Private Registry plan name. Plan of a Managed Private Registry service. Limits and features of each plan are listed by `GET .../reference/managedRegistry/plan`. `LARGE`: Largest storage and request limits. `MEDIUM`: Intermediate storage and request limits. `SMALL`: Smallest storage and request limits.","enum":["LARGE","MEDIUM","SMALL"]},"publicCloud.managedRegistry.PlanFeatures":{"type":"object","description":"Features included in a Managed Private Registry plan","properties":{"vulnerabilityScanner":{"type":"boolean","description":"Whether the plan includes vulnerability scanning of stored artifacts","readOnly":true}}},"publicCloud.managedRegistry.PlanLimits":{"type":"object","description":"Resource limits enforced by a Managed Private Registry plan","properties":{"artifactStorage":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.ValueWithUnit"}],"description":"Maximum storage available for artifacts. See ValueWithUnit.","readOnly":true},"parallelRequests":{"type":"integer","description":"Maximum number of requests the registry serves concurrently","readOnly":true}}},"publicCloud.managedRegistry.Region":{"type":"object","description":"Region where a Managed Private Registry service can be created","properties":{"name":{"type":"string","description":"Region name, to use as `targetSpec.region`, for example `EU-WEST-PAR`","readOnly":true}}},"publicCloud.managedRegistry.Registry":{"type":"object","description":"Managed Private Registry service. Harbor-based container registry. `targetSpec` holds the requested configuration and `currentState` the applied one. They differ while a task is running.","properties":{"checksum":{"type":"string","description":"Checksum. Hash of the current `targetSpec`. Send it back in `PUT .../managedRegistry/{managedRegistryId}` to detect concurrent updates. Changes on every `targetSpec` update.","readOnly":true},"createdAt":{"type":"string","description":"Creation date of the registry","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.RegistryCurrentState"}],"description":"Current state. Configuration applied to the registry. Reported by the service. See RegistryCurrentState.","readOnly":true},"currentTasks":{"type":"array","description":"Current tasks. Asynchronous tasks running on the registry. Empty or null when none is running. Follow `link` to get a task. Reported by the service.","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the registry","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Resource status. Readiness of the registry. A new `targetSpec` is accepted only when it is `READY`. Reported by the service.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.RegistryTargetSpec"}],"description":"Target specification. Last configuration requested for the registry. Mutable through `PUT .../managedRegistry/{managedRegistryId}`. See RegistryTargetSpec.","readOnly":true},"updatedAt":{"type":"string","description":"Date of the last update of the registry","format":"date-time","readOnly":true}}},"publicCloud.managedRegistry.RegistryCreation":{"type":"object","description":"Registry creation request. Request body of `POST .../managedRegistry`.","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.RegistryTargetSpec"}],"description":"Target specification. Configuration the registry is created with. Mutable through `PUT .../managedRegistry/{managedRegistryId}`, except `region`, which is immutable. See RegistryTargetSpec."}},"required":["targetSpec"]},"publicCloud.managedRegistry.RegistryCurrentState":{"type":"object","description":"Observed registry state. Configuration applied to the registry, reported as `currentState`. It matches `targetSpec` once every task has completed.","properties":{"authentication":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.Authentication"}],"description":"Login method applied to the registry. Reported by the service. See Authentication.","readOnly":true},"authorizedIps":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.AuthorizedIps"}],"description":"Authorized IPs. IP filtering applied to the registry. When `rules` is empty or null, any IP is allowed. Reported by the service. See AuthorizedIps.","readOnly":true},"name":{"type":"string","description":"Display name applied to the registry. Reported by the service.","readOnly":true},"plan":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.PlanEnum"}],"description":"Plan applied to the registry. Reported by the service.","readOnly":true},"region":{"type":"string","description":"Region where the registry is deployed, for example `EU-WEST-PAR`. Reported by the service.","readOnly":true},"url":{"type":"string","description":"URL of the Harbor web interface and registry endpoint, for example `https://xxxxxx.eu-west-par.container-registry.ovh.net`. Null until the registry is deployed. Reported by the service.","nullable":true,"readOnly":true},"usage":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.Usage"}],"description":"Resources consumed by the registry. Reported by the service. See Usage.","readOnly":true},"version":{"type":"string","description":"Harbor version running on the registry, for example `2.14.2`. Reported by the service.","readOnly":true}}},"publicCloud.managedRegistry.RegistryTargetSpec":{"type":"object","description":"Desired registry specification. Configuration requested on `POST .../managedRegistry`, and returned as `targetSpec`.","properties":{"authentication":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.Authentication"}],"description":"Login method of the registry. Changing `type` deletes every existing Harbor user of the registry once the update task completes. Robot accounts are kept. See Authentication. Defaults to `LOCAL` authentication.","nullable":true},"authorizedIps":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.AuthorizedIps"}],"description":"Authorized IPs. CIDR blocks allowed to reach the registry, per scope. When omitted or when `rules` is empty, any IP is allowed. The rule list is replaced as a whole. See AuthorizedIps.","nullable":true},"name":{"type":"string","description":"Display name of the registry. Not an identifier. Renaming has no effect on the registry URL."},"plan":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.PlanEnum"}],"description":"Plan of the registry, which sets its storage and request limits and its features. Plans are listed by `GET .../reference/managedRegistry/plan`. Changing it applies the limits and features of the new plan. Plans an existing registry can switch to are listed by `GET .../managedRegistry/{managedRegistryId}/capabilities/plan`."},"region":{"type":"string","description":"Region where the registry is deployed. Regions are listed by `GET .../reference/managedRegistry/region`. Immutable after creation. Create a new registry to change it."},"version":{"type":"string","description":"Harbor version to run, for example `2.14.2`. On `POST .../managedRegistry`, must be null or the latest available version: the registry is always created with the latest version. Mutable through `PUT .../managedRegistry/{managedRegistryId}`, which upgrades the registry.","nullable":true}},"required":["name","plan","region"]},"publicCloud.managedRegistry.RegistryUpdate":{"type":"object","description":"Registry update request. Request body of `PUT .../managedRegistry/{managedRegistryId}`.","properties":{"checksum":{"type":"string","description":"Optimistic concurrency token. When set, it must match the `checksum` returned by `GET .../managedRegistry/{managedRegistryId}`, otherwise the request is rejected. When null or empty, the check is skipped and the update overwrites the current `targetSpec`.","nullable":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.RegistryUpdateTargetSpec"}],"description":"Target specification. New configuration of the registry, replacing the previous one as a whole. See RegistryUpdateTargetSpec."}},"required":["targetSpec"]},"publicCloud.managedRegistry.RegistryUpdateTargetSpec":{"type":"object","description":"Desired registry specification (update). Configuration requested on `PUT .../managedRegistry/{managedRegistryId}`. It replaces the previous `targetSpec` as a whole, so unchanged fields are sent too. `region` is immutable and not part of it.","properties":{"authentication":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.Authentication"}],"description":"Login method of the registry. Changing `type` deletes every existing Harbor user of the registry once the update task completes. Robot accounts are kept. See Authentication. Defaults to `LOCAL` authentication.","nullable":true},"authorizedIps":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.AuthorizedIps"}],"description":"Authorized IPs. CIDR blocks allowed to reach the registry, per scope. When omitted or when `rules` is empty, any IP is allowed. The rule list is replaced as a whole. See AuthorizedIps.","nullable":true},"name":{"type":"string","description":"Display name of the registry. Not an identifier. Renaming has no effect on the registry URL."},"plan":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.PlanEnum"}],"description":"Plan of the registry, which sets its storage and request limits and its features. Must be the current plan or one listed by `GET .../managedRegistry/{managedRegistryId}/capabilities/plan`. Changing it applies the limits and features of the new plan."},"version":{"type":"string","description":"Harbor version to run, for example `2.14.2`. Must be the current version or one listed by `GET .../managedRegistry/{managedRegistryId}/capabilities/version`. Changing it upgrades the registry."}},"required":["name","plan","version"]},"publicCloud.managedRegistry.Usage":{"type":"object","description":"Registry usage. Resources consumed by the registry, compared with the limits of its plan. Reported as `currentState.usage`.","properties":{"artifactStorage":{"allOf":[{"$ref":"#/components/schemas/publicCloud.managedRegistry.ArtifactStorage"}],"description":"Artifact storage consumed and its limit. Reported by the service. See ArtifactStorage.","readOnly":true},"measuredAt":{"type":"string","description":"Measured at. Time of the last usage measurement. Null until the first measurement is collected. Reported by the service.","nullable":true,"format":"date-time","readOnly":true}}},"publicCloud.managedRegistry.ValueWithUnit":{"type":"object","description":"Value with unit. Numeric quantity together with the unit it is expressed in.","properties":{"unit":{"allOf":[{"$ref":"#/components/schemas/publicCloud.quota.QuotaUnitEnum"}],"description":"Unit the value is expressed in, for example `GiB`","readOnly":true},"value":{"type":"integer","description":"Numeric value in `unit`","readOnly":true}}},"publicCloud.managedRegistry.Version":{"type":"object","description":"Harbor version an existing registry can be upgraded to, to use as `targetSpec.version` on `PUT .../managedRegistry/{managedRegistryId}`","properties":{"changelogUrl":{"type":"string","description":"URL of the Harbor release notes of the version","readOnly":true},"name":{"type":"string","description":"Harbor version, for example `2.14.2`","readOnly":true}}},"publicCloud.quota.QuotaUnitEnum":{"type":"string","description":"Unit of measurement for quota limits and usage","enum":["COUNT","GB","GiB","MB","MiB","TB","TiB"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/publicCloud/project/{projectId}/managedRegistry":{"get":{"operationId":"getAllManagedRegistries","summary":"List Managed Private Registry services","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Registry"}},"examples":{"Example":{"value":[{"checksum":"92a64df551425fcc55e4d42a148795d9f25f89d4","createdAt":"2020-12-31T07:39:19Z","currentState":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR","url":"https://aaaaaa.bbbb.registry.ovhcloud.example","usage":{"artifactStorage":{"limit":{"unit":"GiB","value":600},"used":{"unit":"MiB","value":250}},"measuredAt":"2020-12-31T07:39:19Z"},"version":"2.14.2"},"currentTasks":[],"id":"d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","resourceStatus":"READY","targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR"},"updatedAt":"2020-12-31T07:39:19Z"},{"checksum":"5e1f0c8a0d2b4a3e9c6f7d8b1a2c3e4f5a6b7c8d","createdAt":"2020-12-31T13:37:46Z","currentState":{"authentication":{"oidc":{"adminGroup":"harbor-admins","autoOnboard":true,"clientId":"harbor","endpoint":"https://keycloak.example.com/realms/mpr","groupFilter":null,"groupsClaim":"groups","name":"my-oidc","scope":"openid,profile,email,offline_access","userClaim":"preferred_username","verifyCert":true},"type":"OIDC"},"authorizedIps":{"rules":[]},"name":"registry2","plan":"SMALL","region":"EU-WEST-PAR","url":"https://cccccc.bbbb.registry.ovhcloud.example","usage":{"artifactStorage":{"limit":{"unit":"GiB","value":200},"used":{"unit":"MiB","value":120}},"measuredAt":"2020-12-31T07:39:19Z"},"version":"2.14.2"},"currentTasks":[{"id":"30017036-ddb2-40a8-ad56-6d765b059aab","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/222ce105-a3f7-44c4-a7d3-dbb5983c045d/task/30017036-ddb2-40a8-ad56-6d765b059aab","type":"REGISTRY_UPDATE"}],"id":"222ce105-a3f7-44c4-a7d3-dbb5983c045d","resourceStatus":"UPDATING","targetSpec":{"authentication":{"oidc":{"adminGroup":"harbor-admins","autoOnboard":true,"clientId":"harbor","endpoint":"https://keycloak.example.com/realms/mpr","groupFilter":null,"groupsClaim":"groups","name":"my-oidc","scope":"openid,profile,email,offline_access","userClaim":"preferred_username","verifyCert":true},"type":"OIDC"},"authorizedIps":{"rules":[]},"name":"registry2","plan":"SMALL","region":"EU-WEST-PAR"},"updatedAt":"2020-12-31T13:40:46Z"}],"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudManagedRegistryRegistry"},"post":{"operationId":"createManagedRegistry","summary":"Create a Managed Private Registry service","description":"The registry runs the latest available Harbor version. Change it later with `targetSpec.version` on `PUT .../managedRegistry/{managedRegistryId}`.\n\n### Asynchronous creation\n\nThe registry is returned with `resourceStatus` `CREATING` and a `REGISTRY_CREATE` task in `currentTasks`. Poll `GET .../managedRegistry/{managedRegistryId}` until `resourceStatus` is `READY`. `currentState.url` and `currentState.usage` are null until then. Once the registry is `READY`, generate the administrator password with `POST .../managedRegistry/{managedRegistryId}/adminCredentials`.\n\n### Immutable fields\n\n`region` cannot change after creation. Create a new registry to change it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.RegistryCreation"},"examples":{"Create a registry (minimal parameters)":{"value":{"targetSpec":{"name":"my_registry","plan":"SMALL","region":"EU-WEST-PAR"}},"summary":"Create a registry (minimal parameters)"},"Create a registry with IP filtering":{"value":{"targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"192.0.2.0/24","description":"Kubernetes cluster","scopes":["ARTIFACT_OPERATIONS"]},{"cidr":"198.51.100.0/24","description":"VPN","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR"}},"summary":"Create a registry with IP filtering"},"Create a registry with OIDC authentication":{"value":{"targetSpec":{"authentication":{"oidc":{"adminGroup":"harbor-admins","autoOnboard":true,"clientId":"harbor","clientSecret":"my-client-secret","endpoint":"https://keycloak.example.com/realms/mpr","groupFilter":null,"groupsClaim":"groups","name":"my-oidc","scope":"openid,profile,email,offline_access","userClaim":"preferred_username","verifyCert":true},"type":"OIDC"},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR"}},"summary":"Create a registry with OIDC authentication"}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Registry"},"examples":{"Example":{"value":{"checksum":"92a64df551425fcc55e4d42a148795d9f25f89d4","createdAt":"2020-12-31T07:39:19Z","currentState":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"192.0.2.0/24","description":"Kubernetes cluster","scopes":["ARTIFACT_OPERATIONS"]},{"cidr":"198.51.100.0/24","description":"VPN","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR","url":null,"usage":{"artifactStorage":{"limit":{"unit":"GiB","value":600},"used":null},"measuredAt":null},"version":"2.14.2"},"currentTasks":[{"id":"aad7c39d-ed0e-44c3-9624-096a0ef569f2","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/d6b6579e-8d60-4487-bf08-8b4ddf98f7d3/task/aad7c39d-ed0e-44c3-9624-096a0ef569f2","type":"REGISTRY_CREATE"}],"id":"d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","resourceStatus":"CREATING","targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"192.0.2.0/24","description":"Kubernetes cluster","scopes":["ARTIFACT_OPERATIONS"]},{"cidr":"198.51.100.0/24","description":"VPN","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR"},"updatedAt":"2020-12-31T07:39:19Z"},"summary":"Example"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.managedRegistry.RegistryCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/managedRegistry\",\n\ttargetSpec = None, # Target specification. Configuration the registry is created with. Mutable through `PUT .../managedRegistry/{managedRegistryId}`, except `region`, which is immutable. See RegistryTargetSpec. (type: publicCloud.managedRegistry.RegistryTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.managedRegistry.RegistryCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/managedRegistry\", array(\n\ttargetSpec => null, // Target specification. Configuration the registry is created with. Mutable through `PUT .../managedRegistry/{managedRegistryId}`, except `region`, which is immutable. See RegistryTargetSpec. (type: publicCloud.managedRegistry.RegistryTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/create","required":true}]}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}":{"delete":{"operationId":"deleteManagedRegistry","summary":"Delete a Managed Private Registry service","description":"Deletion is asynchronous: the registry moves to `resourceStatus` `DELETING`, the response echoes it, and a `REGISTRY_DELETE` task then removes it. Poll `GET .../managedRegistry/{managedRegistryId}` until the registry is no longer returned. Every artifact stored in the registry is deleted and cannot be recovered.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Registry"},"examples":{"Example":{"value":{"checksum":"92a64df551425fcc55e4d42a148795d9f25f89d4","createdAt":"2020-12-31T07:39:19Z","currentState":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR","url":"https://aaaaaa.bbbb.registry.ovhcloud.example","usage":{"artifactStorage":{"limit":{"unit":"GiB","value":600},"used":{"unit":"MiB","value":250}},"measuredAt":"2020-12-31T07:39:19Z"},"version":"2.14.2"},"currentTasks":[{"id":"6ffe3c08-3b65-4ede-a0e6-8b137e333e54","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/d6b6579e-8d60-4487-bf08-8b4ddf98f7d3/task/6ffe3c08-3b65-4ede-a0e6-8b137e333e54","type":"REGISTRY_DELETE"}],"id":"d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","resourceStatus":"DELETING","targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR"},"updatedAt":"2020-12-31T09:00:00Z"},"summary":"Example"}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ResourceAlreadyBeingDeleted":{"value":{"class":"Client::Conflict::ResourceAlreadyBeingDeleted","message":"Resource is already being deleted"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/delete","required":true}]},"get":{"operationId":"getManagedRegistry","summary":"Get a Managed Private Registry service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Registry"},"examples":{"Example":{"value":{"checksum":"92a64df551425fcc55e4d42a148795d9f25f89d4","createdAt":"2020-12-31T07:39:19Z","currentState":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR","url":"https://aaaaaa.bbbb.registry.ovhcloud.example","usage":{"artifactStorage":{"limit":{"unit":"GiB","value":600},"used":{"unit":"MiB","value":250}},"measuredAt":"2020-12-31T07:39:19Z"},"version":"2.14.2"},"id":"d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","resourceStatus":"READY","targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR"},"updatedAt":"2020-12-31T07:39:19Z"},"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editManagedRegistry","summary":"Update a Managed Private Registry service","description":"### Asynchronous update\n\nThe new `targetSpec` replaces the previous one, the registry moves to `resourceStatus` `UPDATING` and a `REGISTRY_UPDATE` task starts. Poll `GET .../managedRegistry/{managedRegistryId}` until `resourceStatus` is `READY` and `currentState` reflects the change.\n\n### Optimistic concurrency\n\nSend the `checksum` read from the last `GET`. When another update happened in between, the checksums differ and the request is rejected: read the registry again and retry. Omitting `checksum` skips the check.\n\n### Immutable fields\n\n`region` is set at creation and is not part of the update body. Create a new registry to change it.\n\n### Destructive updates\n\nChanging `authentication.type` deletes every existing Harbor user of the registry once the update task completes. Robot accounts are kept.\n\n### Rejected requests\n\nThe request is rejected when `resourceStatus` is not `READY`, or when `plan` or `version` is neither the current value nor listed by `GET .../managedRegistry/{managedRegistryId}/capabilities/plan` or `GET .../managedRegistry/{managedRegistryId}/capabilities/version`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.RegistryUpdate"},"examples":{"Example":{"value":{"checksum":"92a64df551425fcc55e4d42a148795d9f25f89d4","targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"192.0.2.0/24","description":"Kubernetes cluster","scopes":["ARTIFACT_OPERATIONS"]},{"cidr":"198.51.100.0/24","description":"VPN","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"LARGE","version":"2.14.2"}},"summary":"Example"}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Registry"},"examples":{"Example":{"value":{"checksum":"3b8c1e9f2a7d4c6b8e0f1a2b3c4d5e6f7a8b9c0d","createdAt":"2020-12-31T07:39:19Z","currentState":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"198.51.100.1/32","description":"My IP restriction","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"MEDIUM","region":"EU-WEST-PAR","url":"https://aaaaaa.bbbb.registry.ovhcloud.example","usage":{"artifactStorage":{"limit":{"unit":"GiB","value":600},"used":{"unit":"MiB","value":250}},"measuredAt":"2020-12-31T07:39:19Z"},"version":"2.14.2"},"currentTasks":[{"id":"8e2478fa-af3b-4576-b344-af3546f52b5b","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/d6b6579e-8d60-4487-bf08-8b4ddf98f7d3/task/8e2478fa-af3b-4576-b344-af3546f52b5b","type":"REGISTRY_UPDATE"}],"id":"d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","resourceStatus":"UPDATING","targetSpec":{"authentication":{"oidc":null,"type":"LOCAL"},"authorizedIps":{"rules":[{"cidr":"192.0.2.0/24","description":"Kubernetes cluster","scopes":["ARTIFACT_OPERATIONS"]},{"cidr":"198.51.100.0/24","description":"VPN","scopes":["ADMINISTRATION","ARTIFACT_OPERATIONS"]}]},"name":"my_registry","plan":"LARGE","region":"EU-WEST-PAR"},"updatedAt":"2020-12-31T08:00:00Z"},"summary":"Example"}}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ChecksumMismatch":{"value":{"class":"Client::Conflict::ChecksumMismatch","message":"Checksum mismatch — a concurrent update was detected. Refresh the resource and retry"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.managedRegistry.RegistryUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}\",\n\tchecksum = None, # Optimistic concurrency token. When set, it must match the `checksum` returned by `GET .../managedRegistry/{managedRegistryId}`, otherwise the request is rejected. When null or empty, the check is skipped and the update overwrites the current `targetSpec`. (type: string, nullable)\n\ttargetSpec = None, # Target specification. New configuration of the registry, replacing the previous one as a whole. See RegistryUpdateTargetSpec. (type: publicCloud.managedRegistry.RegistryUpdateTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.managedRegistry.RegistryUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}\", array(\n\tchecksum => null, // Optimistic concurrency token. When set, it must match the `checksum` returned by `GET .../managedRegistry/{managedRegistryId}`, otherwise the request is rejected. When null or empty, the check is skipped and the update overwrites the current `targetSpec`. (type: string, nullable)\n\ttargetSpec => null, // Target specification. New configuration of the registry, replacing the previous one as a whole. See RegistryUpdateTargetSpec. (type: publicCloud.managedRegistry.RegistryUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/edit","required":true}]}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/adminCredentials":{"post":{"operationId":"resetManagedRegistryAdminCredentials","summary":"Reset the administrator password of a Managed Private Registry service","description":"Generates a new password for the Harbor administrator account and returns it. The previous password stops working immediately. The password is returned only in this response.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Credentials"},"examples":{"Example":{"value":{"password":"u}m.ZBA'\u003eg?!D3DD","username":"harbor-admin"},"summary":"Example"}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/adminCredentials\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/adminCredentials\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/adminCredentials/reset","required":true}]}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/plan":{"get":{"operationId":"getManagedRegistryPlans","summary":"List plans a Managed Private Registry service can switch to","description":"Any `name` listed can be set as `targetSpec.plan` on `PUT .../managedRegistry/{managedRegistryId}`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Plan"}},"examples":{"Example":{"value":[{"features":{"vulnerabilityScanner":true},"limits":{"artifactStorage":{"unit":"TiB","value":5},"parallelRequests":90},"name":"LARGE"}],"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/plan\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/plan\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/capabilities/plan/get","required":true}]}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/version":{"get":{"operationId":"getManagedRegistryVersions","summary":"List Harbor versions a Managed Private Registry service can be upgraded to","description":"Only versions available as an upgrade from the version the registry currently runs are listed. To upgrade, set a listed `name` as `targetSpec.version` on `PUT .../managedRegistry/{managedRegistryId}`.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Version"}},"examples":{"Example":{"value":[{"changelogUrl":"https://github.com/goharbor/harbor/releases/tag/v2.14.2","name":"2.14.2"}],"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/version\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/capabilities/version\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/capabilities/version/get","required":true}]}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/event":{"get":{"operationId":"getManagedRegistryEvents","summary":"List events of a Managed Private Registry service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Event"}},"examples":{"Example":{"value":[{"createdAt":"2020-12-31T20:10:01Z","kind":"REGISTRY_UPDATE","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/d6b6579e-8d60-4487-bf08-8b4ddf98f7d3/task/8e2478fa-af3b-4576-b344-af3546f52b5b","message":"Task started to update Registry","type":"TASK_START"},{"createdAt":"2020-12-01T20:10:00Z","kind":"REGISTRY_UPDATE","message":"Registry target spec updated","type":"TARGET_SPEC_UPDATE"}],"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/event\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/event\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/event/get","required":true}]}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task":{"get":{"operationId":"getAllManagedRegistryTasks","summary":"List asynchronous tasks of a Managed Private Registry service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common.Task"}},"examples":{"Example":{"value":[{"createdAt":"2020-12-01T20:00:00Z","errors":[],"id":"6ffe3c08-3b65-4ede-a0e6-8b137e333e54","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","message":"Cloud project a755273a123456788da6d6fcc71a95f3: update registry d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","progress":[{"name":"test","status":"RUNNING"},{"name":"another step","status":"DONE"},{"name":"yet another step","status":"PENDING"}],"startedAt":"2020-12-01T20:01:00Z","status":"RUNNING","type":"REGISTRY_UPDATE","updatedAt":"2020-12-01T20:02:00Z"}],"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/task/get","required":true}],"x-response-identifier":"id","x-expanded-response":"CommonTask"}},"/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task/{taskId}":{"get":{"operationId":"getManagedRegistryTask","summary":"Get an asynchronous task of a Managed Private Registry service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"managedRegistryId","description":"Managed registry ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","description":"Task ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common.Task"},"examples":{"Example":{"value":{"createdAt":"2020-12-01T20:00:00Z","errors":[],"id":"6ffe3c08-3b65-4ede-a0e6-8b137e333e54","link":"/v2/publicCloud/project/a755273a123456788da6d6fcc71a95f3/managedRegistry/d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","message":"Cloud project a755273a123456788da6d6fcc71a95f3: update registry d6b6579e-8d60-4487-bf08-8b4ddf98f7d3","progress":[{"name":"test","status":"RUNNING"},{"name":"another step","status":"DONE"},{"name":"yet another step","status":"PENDING"}],"startedAt":"2020-12-01T20:01:00Z","status":"RUNNING","type":"REGISTRY_UPDATE","updatedAt":"2020-12-01T20:02:00Z"},"summary":"Example"}}}}}},"tags":["Managed Registry"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/managedRegistry/{managedRegistryId}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:managedRegistry/task/get","required":true}],"x-response-identifier":"id"}},"/publicCloud/project/{projectId}/reference/managedRegistry/plan":{"get":{"operationId":"getRegistryPlans","summary":"List plans available to create a Managed Private Registry service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Plan"}},"examples":{"Example":{"value":[{"features":{"vulnerabilityScanner":false},"limits":{"artifactStorage":{"unit":"GiB","value":200},"parallelRequests":15},"name":"SMALL"}],"summary":"Example"}}}}}},"tags":["Reference"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/reference/managedRegistry/plan\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/reference/managedRegistry/plan\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:reference/managedRegistry/plan/get","required":true}]}},"/publicCloud/project/{projectId}/reference/managedRegistry/region":{"get":{"operationId":"getRegistryRegions","summary":"List regions available to create a Managed Private Registry service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.managedRegistry.Region"}},"examples":{"Example":{"value":[{"name":"DE"},{"name":"EU-WEST-PAR"}],"summary":"Example"}}}}}},"tags":["Reference"],"x-developer-hub-navigation":[["Public Cloud","Container","Managed Private Registry"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/reference/managedRegistry/region\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/reference/managedRegistry/region\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:reference/managedRegistry/region/get","required":true}]}}},"tags":[{"name":"Managed Registry","x-tag-expanded":false,"description":"Missing description"},{"name":"Reference","x-tag-expanded":false,"description":"Missing description"}]}
