Manage Monitored Resources

Update the monitoring status of a smart contract

Updates the resource monitoring status to be either active or inactive for the given Resource Monitoring ID. Updating the status to be inactive will pause Overledger recording updates for the requested smart contract

SecurityOAuth2_Security_Scheme
Request
path Parameters
resourceMonitoringId
required
string [ 0 .. 36 ] characters ^[a-zA-Z0-9-]{1,36}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Request Body schema: application/json
object (StatusUpdateSchema)
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

patch/v2/resourcemonitoring/smartcontractevent/{resourceMonitoringId}
Request samples
application/json

Update Monitoring

{
  • "statusUpdate": {
    }
}
Response samples
application/json

Update Monitoring

{
  • "smartContractEventMonitoringDetails": {
    },
  • "resourceMonitoring": {
    }
}

Retrieve recorded updates for a specific monitored smart contract

Returns the update information recorded in Overledger for asmart contract being monitored by your application for a given Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
path Parameters
resourceMonitoringId
required
string [ 0 .. 36 ] characters ^[a-zA-Z0-9-]{1,36}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

get/v2/resourcemonitoring/smartcontractevent/{resourceMonitoringId}
Request samples
Response samples
application/json

Get Resource Monitoring Details

{
  • "smartContractEventHistory": [ ],
  • "smartContractEventDetails": {
    },
  • "location": {
    },
  • "type": "Smart Contract Event",
  • "status": {
    },
  • "timestamp": "2021-09-22T12:46:19.810922Z"
}

Stop monitoring a smart contract

Deletes the tracking record in Overledger to stop Overledger from recording updates for a smart contract based on the given Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
path Parameters
resourceMonitoringId
required
string [ 0 .. 36 ] characters ^[a-zA-Z0-9-]{1,36}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

delete/v2/resourcemonitoring/smartcontractevent/{resourceMonitoringId}
Request samples
Response samples
application/json

Update Monitoring

{
  • "smartContractEventMonitoringDetails": {
    },
  • "resourceMonitoring": {
    }
}

Update the monitoring status of an address

Updates the resource monitoring status to be either active or inactive for the given Resource Monitoring ID. Updating the status to beinactive will pause Overledger recording updates for the requested address

SecurityOAuth2_Security_Scheme
Request
path Parameters
resourceMonitoringId
required
string [ 0 .. 36 ] characters ^[a-zA-Z0-9-]{1,36}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Request Body schema: application/json
object (StatusUpdateSchema)
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

patch/v2/resourcemonitoring/address/{resourceMonitoringId}
Request samples
application/json

Update Monitoring

{
  • "statusUpdate": {
    }
}
Response samples
application/json

Update Resource Monitoring

{
  • "addressMonitoringDetails": {
    },
  • "resourceMonitoring": {
    }
}

Retrieve recorded updates for a specific monitored address

Returns the update information recorded in Overledger for an address being monitored by your application for a given Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
path Parameters
resourceMonitoringId
required
string [ 0 .. 36 ] characters ^[a-zA-Z0-9-]{1,36}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

get/v2/resourcemonitoring/address/{resourceMonitoringId}
Request samples
Response samples
application/json

Get Resource Monitoring

{
  • "location": {
    },
  • "addressDetails": {
    },
  • "addressHistory": [
    ],
  • "type": "Address",
  • "timestamp": "1626692612",
  • "status": {
    }
}

Stop monitoring an address

Deletes the tracking record in Overledger to stop Overledger from recording updates for an address based on the given Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
path Parameters
resourceMonitoringId
required
string [ 0 .. 36 ] characters ^[a-zA-Z0-9-]{1,36}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

delete/v2/resourcemonitoring/address/{resourceMonitoringId}
Request samples
Response samples
application/json

Delete Resource Monitoring

{
  • "addressMonitoringDetails": {
    },
  • "resourceMonitoring": {
    }
}

Retrieve a list of addresses being monitored

Returns a list of addresses being monitored for your application and the corresponding Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

get/v2/resourcemonitoring/addresses
Request samples
Response samples
application/json

List Resource Monitoring

[
  • {
    }
]

Retrieve a list of smart contracts being monitored

Returns a list of smart contracts being monitored for your application and the corresponding Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

get/v2/resourcemonitoring/smartcontractevents
Request samples
Response samples
application/json

List Resource Monitoring

[
  • {
    }
]

Retrieve a list of all resources being monitored

Returns a list of all of the resources being monitored for your application and the corresponding Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

500

Something went wrong on our side

get/v2/resourcemonitoring
Request samples
Response samples
application/json

List Resource Monitoring

[
  • {
    }
]