Search
K
Cipherscale API

Admission Rules

Access control rules and conditions

Create Admission Rule

Creates a new admission rule that defines conditions for allowing or denying access to network resources. Admission rules can include time constraints and custom logic for fine-grained access control.

post
https://public-api.cipherscale.com/qa/tenants/admission-rules

Body

application/json

The admission rule data to create

CreateAdmissionRuleDto

rulestringrequired
namestringrequired
hasTimeConstraintbooleanrequired

Response

application/json

Successfully created the admission rule

AdmissionRuleDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:ALLOWDENYCUSTOM

hasTimeConstraintbooleanrequired
rulestring
post/tenants/admission-rules

Body

{ "rule": "rule", "name": "name", "hasTimeConstraint": false }
 
application/json

List All Admission Rules

Retrieves all admission rules configured for the tenant, showing the complete set of access control conditions that govern network access.

get
https://public-api.cipherscale.com/qa/tenants/admission-rules

Response

application/json

Successfully retrieved admission rules

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:ALLOWDENYCUSTOM

hasTimeConstraintbooleanrequired
rulestring
get/tenants/admission-rules
 
application/json

Update Admission Rule

Modifies the configuration of an existing admission rule including its name, rule logic, and time constraints. Changes affect access control immediately.

put
https://public-api.cipherscale.com/qa/tenants/admission-rules/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the admission rule to update

Body

application/json

The admission rule data to update

UpdateAdmissionRuleDto

rulestringrequired
namestringrequired
hasTimeConstraintbooleanrequired

Response

application/json

Successfully updated the admission rule

AdmissionRuleDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:ALLOWDENYCUSTOM

hasTimeConstraintbooleanrequired
rulestring
put/tenants/admission-rules/{id}

Body

{ "rule": "rule", "name": "name", "hasTimeConstraint": false }
 
application/json

Get Admission Rule Details

Retrieves detailed information about a specific admission rule including its configuration, rule logic, time constraints, and type (ALLOW/DENY/CUSTOM).

get
https://public-api.cipherscale.com/qa/tenants/admission-rules/{id}

Path Parameters

idstring(uuid)required

The unique identifier (UUID) of the admission rule

Response

application/json

Successfully retrieved the admission rule

AdmissionRuleDto

idstring(uuid)required
createdAtstring(date-time)required
updatedAtstring(date-time)required
namestringrequired
typestringrequired

Allowed values:ALLOWDENYCUSTOM

hasTimeConstraintbooleanrequired
rulestring
get/tenants/admission-rules/{id}
 
application/json