Services

List Compute Resources

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Query parameters
namesstring[]Optional

Names, example: resource01,!resource02,resource42

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

sortanyOptional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

directionstringOptional
cloudsintegerOptional
pagestringOptional

Results page you want to retrieve (0..N)

sizestringOptional

Number of records per page.

Responses
200

OK

*/*
get
/compute/services

Get service

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 123

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}

List Actions In Progress

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required
Query parameters
categorystringOptional

Category, example: INSTANCES

Default: ""
Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/actions-in-progress

Get Application servers

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

backupbooleanOptional

Backup

drpbooleanOptional

Drp

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/application-servers

Get MessageBrokers

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Broker name, example: deblaprmq01

statusesstring[]Optional

Broker status, example: ACTIVE

versionsstring[]Optional

Broker version, example: 3.9

sizesstring[]Optional

Broker size, example: 4cpu8gb

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/brokers

Get Hardwares

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: PET1

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/hardwares

Get Instances

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

familiesstring[]Optional

Families, example: DEBIAN,RHEL

backupbooleanOptional

Backup

drpbooleanOptional

Drp

withManagedNodesbooleanOptional

withManagedNodes

withApplicationServersbooleanOptional

withApplicationServers

withOracleDbsbooleanOptional

withOracleDbs

withMongoNodeJsbooleanOptional

withMongoNodeJs

withAppliancesbooleanOptional

withAppliances

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/instances

Get Kubernetes Containers

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

versionsstring[]Optional

Versions, example: EB,ET,NK

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/kubernetes

Get Load Balancers

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional
statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

nodesinteger · int32Optional

Number of Members, example: 2

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/loadbalancers

Get Managed Databases

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional
statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/managed-databases

Get Network Clusters

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: PET1

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/network-clusters

Get exclusion from Patch Party

get

This method allows to update the partch party informations related to the given service.

Structure of payload is generic and describes :

  • an array containing the patch party configuration to apply for each resource of the given service
  • If the resource is to be excluded from the patch parties, an explanation must be given.
  • If the resource is to be included to the patch parties, an patchGroup should be given unless the resource is part of a cluster.

Update Patch Party Statuses

PATCH /services/1234/patch-policies
[
    {
        "resourceId": 500079802,
        "excluded": false,
        "exclusionReason": "I don't want to include this resource"
    },
    {
        "resourceId": 500079545,
        "excluded": true,
        "patchGroup": "2"
    },
    {
        "resourceId": 500057033,
        "excluded": false,
        "exclusionReason": "Wrong patch group is set",
        "patchGroup": "1c"
    },
    {
        "resourceId": 500057055,
        "excluded": false,
        "patchGroup": "1"
    }
]
  • The response will give the status of all the submitted resources, for example :
[
    {
        "status": "FAILED",
        "message": "The patch group is only allowed when the farm has one member",
        "id": -1,
        "internalId": 500057055
    },
    {
        "status": "IN_PROGRESS",
        "message": "Include PatchParty SQLServer rhutsql20",
        "process": "INCLUDE_PATCHPARTY",
        "id": 500079545,
        "lastUpdatedAt": "2023-11-16T11:53:42.888+00:00"
    },
    {
        "status": "FAILED",
        "message": "Wrong patch party group set",
        "id": -1,
        "internalId": 500057033
    },
    {
        "id": 202
    }
]

There are 3 groups available defining the sequence on which the instance should be updated: 1 (First Group), 2 (Second Group) or 3 (Third Group).

If no group is set, it means that you have no preference while defining the sequences.

Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
withHistorybooleanOptional

boolean flag to fetch history details for every ci

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/patch-policies

Update patch party

patch
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Bodyobject[]

Update Patch party configuration for resources of a service

excludedbooleanOptional
exclusionReasonstringOptional
patchGroupstringOptional
resourceIdinteger · int64Required
Responses
200

OK

application/vnd.cegedim-it.v1+json
patch
/compute/services/{id}/patch-policies

Get Service Relations

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/relations

Get Service Relations Stats

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/relations/stats

Get Service Resources

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: REBMYAPP01,REBMYSRV

categoriesstring[]Optional

Categories, example: INSTANCES,APPLICATION_SERVERS,LOAD_BALANCERS

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/resources

Get Service Stats

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 123

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/stats

Get Service Storage

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
idinteger · int64Required

Service Id, example: 44411

Query parameters
namesstring[]Optional

Names, example: devvcaglfs02

statusesstring[]Optional

Statuses, example: ACTIVE,INACTIVE,PREPARATION

sizesstringOptional

Sizing of the resource, example: 2cpu4gb

nodeCountinteger · int32Optional

Number of nodes, example: 2

vipstringOptional

IP Address, ex: 10.10.10.10

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{id}/storage

List history

get
Authorizations
OAuth2implicitRequired

OAuth2 flow

Authorization URL:
Available scopes:
  • : openid
  • : email
Path parameters
serviceIdinteger · int64Required

Service Id, example: 500063721

Query parameters
actionsstring[]Optional

Actions, example: enable_monitoring

statusesstring[]Optional

Statuses, example: SUCCESS

namesstring[]Optional

Names, example: REBITTEST01

Responses
200

OK

application/vnd.cegedim-it.v1+json
get
/compute/services/{serviceId}/history

Last updated