Update one sub key

put

https://api.geoconcept.com/tsapi/updateSubKey

Increasing the value of creditsPerDay will automatically reset the daily limit. if creditsPerDay is decreased, remainingCredits will take the minimum valuebetween current remainingCredits and new creditsPerDay values.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Api sub key definition

creationDate

date-time

creditResetDate

date-time

Credits usage are fully reset after 24 hours. Reset is done only when an
optimization is started. When the first optimization of the period is
started, creditResetDate is set to now+24h. This date is reset only when
starting a new optimization and when creditResetDate is in the past.

creditsPerDay

int64

Max usable credits per day. It must be positive if useCredits = true

description

string

enabled

boolean

If false, using this subkey will result in a 403 response.

expirationDate

date-time

Subkey expiration date. Using this subkey after this date will result in a 403 response.

key

string

Read only value, it will be generated automatically

modificationDate

date-time

name

string

This name can be used to filter the list of subKeys

remainingCredits

int64

Number of remaining credits (if used). This value is decreased after each
optimization. It will be reset to "creditsPerDay" value after 24 hours.
The reset action is triggered by a new optimization launch if
creditResetDate is in the past.

totalUsedCredits

int64

Read only value, incremented for each optimization.

useCredits

boolean

If true, creditsParDay must be positive

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

defaultSubKeyResult