Skip to main content

Find images by searching criteria

GET 
/projects/:projectId/images

Return images that match all searching criteria. Criteria are image name and public/private image. A request without searching criteria returns all images contained in the catalog.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

Query Parameters

    name string

    Name of the resource.

    isPrivate boolean

    Flag indicating if the image is private or public. By default, both public and private images will be returned. This property can be used as filter to retrieve only public or private images.

    offset int32

    Default value: 0

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    limit int32

    Possible values: >= 1

    Default value: 100

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

    X-API-Key string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Response Headers

  • X-Result-Count

    integer

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

  • X-Total-Count

    integer

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

Schema

  • Array [

    • name stringrequired

    Unique resource name.

    description string

    Resource description.

    isPrivate booleanrequired

    Flag indicating if the image is private or public. By default, both public and private images will be returned. This property can be used as filter to retrieve only public or private images.

    version stringrequired

    Version of the image.

    vendor stringrequired

    Vendor of the image.

  • ]

Loading...