RepositoriesApi

All URIs are relative to https://api.ionos.com/containerregistries

MethodHTTP requestDescription

Delete /registries/{registryId}/repositories/{repositoryName}

Delete repository

Get /registries/{registryId}/repositories/{repositoryName}

Retrieve Repository

Get /registries/{registryId}/repositories

Retrieve all Repositories

RegistriesRepositoriesDelete

var result  = RegistriesRepositoriesDelete(ctx, registryId, repositoryName)
                      .Execute()

Delete repository

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-container-registry"
)

func main() {
    registryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | The unique ID of the registry
    repositoryName := "my-service" // string | The name of the repository

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resp, err := apiClient.RepositoriesApi.RegistriesRepositoriesDelete(context.Background(), registryId, repositoryName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RepositoriesApi.RegistriesRepositoriesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
}

Path Parameters

NameTypeDescriptionNotes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

registryId

string

The unique ID of the registry

repositoryName

string

The name of the repository

Other Parameters

Other parameters are passed through a pointer to an apiRegistriesRepositoriesDeleteRequest struct via the builder pattern

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RepositoriesApiService.RegistriesRepositoriesDelete" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RepositoriesApiService.RegistriesRepositoriesDelete": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RepositoriesApiService.RegistriesRepositoriesDelete": {
    "port": "8443",
},
})

RegistriesRepositoriesFindByName

var result RepositoryRead = RegistriesRepositoriesFindByName(ctx, registryId, repositoryName)
                      .Execute()

Retrieve Repository

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-container-registry"
)

func main() {
    registryId := "1e41a73c-59d0-5507-86dd-fa2fc2501cfd" // string | The ID (UUID) of the Registry.
    repositoryName := "my-service" // string | The Name of the Repository that should be retrieved.

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.RepositoriesApi.RegistriesRepositoriesFindByName(context.Background(), registryId, repositoryName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RepositoriesApi.RegistriesRepositoriesFindByName``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `RegistriesRepositoriesFindByName`: RepositoryRead
    fmt.Fprintf(os.Stdout, "Response from `RepositoriesApi.RegistriesRepositoriesFindByName`: %v\n", resource)
}

Path Parameters

NameTypeDescriptionNotes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

registryId

string

The ID (UUID) of the Registry.

repositoryName

string

The Name of the Repository that should be retrieved.

Other Parameters

Other parameters are passed through a pointer to an apiRegistriesRepositoriesFindByNameRequest struct via the builder pattern

Return type

RepositoryRead

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RepositoriesApiService.RegistriesRepositoriesFindByName" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RepositoriesApiService.RegistriesRepositoriesFindByName": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RepositoriesApiService.RegistriesRepositoriesFindByName": {
    "port": "8443",
},
})

RegistriesRepositoriesGet

var result RepositoryReadList = RegistriesRepositoriesGet(ctx, registryId)
                      .Offset(offset)
                      .Limit(limit)
                      .FilterName(filterName)
                      .FilterVulnerabilitySeverity(filterVulnerabilitySeverity)
                      .OrderBy(orderBy)
                      .Execute()

Retrieve all Repositories

Example

package main

import (
    "context"
    "fmt"
    "os"

    ionoscloud "github.com/ionos-cloud/sdk-go-container-registry"
)

func main() {
    registryId := "1e41a73c-59d0-5507-86dd-fa2fc2501cfd" // string | The ID (UUID) of the Registry.
    offset := int32(0) // int32 | The first element (of the total list of elements) to include in the response. Use together with limit for pagination. (optional) (default to 0)
    limit := int32(100) // int32 | The maximum number of elements to return. Use together with offset for pagination. (optional) (default to 100)
    filterName := "filterName_example" // string | Filter resources by name. (optional)
    filterVulnerabilitySeverity := "filterVulnerabilitySeverity_example" // string | Filter resources by vulnerability severity. (optional)
    orderBy := "orderBy_example" // string | The field to order the results by. If not provided, the results will be ordered by the default field. (optional) (default to "-lastPush")

    configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := ionoscloud.NewAPIClient(configuration)
    resource, resp, err := apiClient.RepositoriesApi.RegistriesRepositoriesGet(context.Background(), registryId).Offset(offset).Limit(limit).FilterName(filterName).FilterVulnerabilitySeverity(filterVulnerabilitySeverity).OrderBy(orderBy).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RepositoriesApi.RegistriesRepositoriesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `RegistriesRepositoriesGet`: RepositoryReadList
    fmt.Fprintf(os.Stdout, "Response from `RepositoriesApi.RegistriesRepositoriesGet`: %v\n", resource)
}

Path Parameters

NameTypeDescriptionNotes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

registryId

string

The ID (UUID) of the Registry.

Other Parameters

Other parameters are passed through a pointer to an apiRegistriesRepositoriesGetRequest struct via the builder pattern

NameTypeDescriptionNotes

offset

int32

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

[default to 0]

limit

int32

The maximum number of elements to return. Use together with offset for pagination.

[default to 100]

filterName

string

Filter resources by name.

filterVulnerabilitySeverity

string

Filter resources by vulnerability severity.

orderBy

string

The field to order the results by. If not provided, the results will be ordered by the default field.

[default to "-lastPush"]

Return type

RepositoryReadList

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "RepositoriesApiService.RegistriesRepositoriesGet" string. Similar rules for overriding default operation server index and variables apply by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), {packageName}.ContextOperationServerIndices, map[string]int{
    "RepositoriesApiService.RegistriesRepositoriesGet": 2,
})
ctx = context.WithValue(context.Background(), {packageName}.ContextOperationServerVariables, map[string]map[string]string{
    "RepositoriesApiService.RegistriesRepositoriesGet": {
    "port": "8443",
},
})

Last updated