Hercules.API.Agents

Documentation

data AgentsAPI auth f

Constructors

AgentsAPI

Fields

• clusterJoinTokensByAccount :: f :- (Summary "List all cluster join tokens in an account." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("clusterJoinTokens" :> (auth :> Get '[JSON] [ClusterJoinToken])))))
• clusterJoinTokenCreate :: f :- (Summary "Generate a new cluster join token for agents to be added to this account." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("clusterJoinTokens" :> (ReqBody '[JSON] CreateClusterJoinToken :> (auth :> Post '[JSON] FullClusterJoinToken))))))
• clusterJoinTokenDelete :: f :- (Summary "Delete an cluster join token in the account. No new agents will be able to join this account with the specified token." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("clusterJoinTokens" :> (Capture' '[Required, Strict] "clusterJoinTokenId" (Id ClusterJoinToken) :> (auth :> Delete '[JSON] NoContent))))))
• agentSessionsByAccount :: f :- (Summary "Show the agents sessions owned by the account." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("agentSessions" :> (auth :> Get '[JSON] [AgentSession])))))

Instances

Generic (AgentsAPI auth f)

Defined in Hercules.API.Agents

Associated Types

type Rep (AgentsAPI auth f) :: Type -> Type

Methods

from :: AgentsAPI auth f -> Rep (AgentsAPI auth f) x

to :: Rep (AgentsAPI auth f) x -> AgentsAPI auth f

type Rep (AgentsAPI auth f)

Defined in Hercules.API.Agents

type Rep (AgentsAPI auth f) = D1 ('MetaData "AgentsAPI" "Hercules.API.Agents" "hercules-ci-api-0.6.0.1-L0iUsBHZSJOKN1YKeFqdwV" 'False) (C1 ('MetaCons "AgentsAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterJoinTokensByAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "List all cluster join tokens in an account." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("clusterJoinTokens" :> (auth :> Get '[JSON] [ClusterJoinToken]))))))) :*: S1 ('MetaSel ('Just "clusterJoinTokenCreate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Generate a new cluster join token for agents to be added to this account." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("clusterJoinTokens" :> (ReqBody '[JSON] CreateClusterJoinToken :> (auth :> Post '[JSON] FullClusterJoinToken))))))))) :*: (S1 ('MetaSel ('Just "clusterJoinTokenDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Delete an cluster join token in the account. No new agents will be able to join this account with the specified token." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("clusterJoinTokens" :> (Capture' '[Required, Strict] "clusterJoinTokenId" (Id ClusterJoinToken) :> (auth :> Delete '[JSON] NoContent)))))))) :*: S1 ('MetaSel ('Just "agentSessionsByAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Show the agents sessions owned by the account." :> ("accounts" :> (Capture' '[Required, Strict] "accountId" (Id Account) :> ("agentSessions" :> (auth :> Get '[JSON] [AgentSession]))))))))))