OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations DomainNameIndex API
description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
termsOfService: https://delinea.com/eula
contact:
name: Support
url: https://delinea.com
version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: DomainNameIndex
description: DomainNameIndexController
paths:
/v1/domain-index/delete-all:
delete:
tags:
- DomainNameIndex
summary: Delete all domain name index records
description: Delete existing domain name index records
operationId: DomainNameIndexService_TruncateDomainNameIndex
responses:
'200':
description: Delete success
content:
application/json:
schema:
description: Boolean
type: boolean
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/domain-index:
get:
tags:
- DomainNameIndex
summary: Get a domain name index
description: Returns the domain name index
operationId: DomainNameIndexService_GetDomainNameIndex
parameters:
- name: filter.discoverySourceIdScanned
in: query
description: DiscoverySourceIdScanned
required: false
x-nullable: true
schema:
type: integer
format: int32
- name: filter.domainName
in: query
description: DomainName
required: false
schema:
type: string
- name: filter.domainResolveType
in: query
description: DomainResolveType
required: false
x-nullable: true
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: The Domain Name Index View
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfDomainNameIndexSummary'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/domain-index/{id}:
patch:
tags:
- DomainNameIndex
summary: Update a domain name index
description: Update an existing domain name index using the existing domain name index ID
operationId: DomainNameIndexService_UpdateDomainNameIndex
parameters:
- name: id
in: path
description: Domain Name Index ID
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNameIndexUpdateArgs'
description: args
responses:
'200':
description: The updated domain name index
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNameIndexModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/domain-index/create:
post:
tags:
- DomainNameIndex
summary: Create a new domain name index
description: Creates a new domain name index with suggested discovery source id
operationId: DomainNameIndexService_CreateDomainNameIndex
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNameIndexCreateArgs'
description: args
responses:
'200':
description: The new domain name index
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNameIndexModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/domain-index/expire/{id}:
post:
tags:
- DomainNameIndex
summary: Expire a domain name index
description: Expire an existing domain name index using the existing domain name index ID
operationId: DomainNameIndexService_ExpireSingleDomainNameIndex
parameters:
- name: id
in: path
description: Domain Name Index ID
required: true
schema:
type: integer
format: int32
responses:
'200':
description: The updated domain name index
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNameIndexModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/domain-index/expire-all:
post:
tags:
- DomainNameIndex
summary: Expire all domain name index records
description: Expire existing domain name index records
operationId: DomainNameIndexService_ExpireAllDomainNameIndex
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNameIndexExpireUpdateArgs'
description: args
responses:
'200':
description: Expire success
content:
application/json:
schema:
description: Boolean
type: boolean
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/domain-index/delete/{id}:
put:
tags:
- DomainNameIndex
summary: Delete a domain name index
description: Delete an existing domain name index using the existing domain name index ID
operationId: DomainNameIndexService_DeleteSingleDomainNameIndex
parameters:
- name: id
in: path
description: Delete success
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Delete success
content:
application/json:
schema:
description: Boolean
type: boolean
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
components:
schemas:
Sort:
description: Sort options. Multiple sort options can be provided in the query string.
required:
- name
- direction
properties:
direction:
$ref: '#/components/schemas/SortDirection'
name:
description: Sort field name
type: string
priority:
description: Priority index. Sorts with lower values are executed earlier
type: integer
format: int32
type: object
UpdateFieldValueOfBoolean:
description: Active
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: boolean
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
InternalServerErrorResponse:
description: Response object for internal server errors
required:
- message
- exceptionMessage
- exceptionType
- stackTrace
properties:
message:
description: Error message
type: string
exceptionMessage:
description: Error message from exception
type: string
exceptionType:
description: Exception type
type: string
stackTrace:
description: Exception stack trace
type: string
type: object
UpdateFieldValueOfOptionalInt32:
description: The minimum length required for local user passwords
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: integer
format: int32
nullable: true
type: object
BadRequestResponse:
description: Response object for invalid requests
required:
- message
properties:
message:
description: Error message
type: string
messageDetail:
description: Error message detail
type: string
errorCode:
description: Error message code
type: string
modelState:
description: An object describing validation errors
type: object
type: object
DomainResolveType:
description: DomainResolveType
properties: {}
type: string
enum:
- CouldNotResolve
- MatchedDomainInDb
- MatchedFQDNOrFriendlyOrNetBIOSInDb
- MatchedFriendlyNameWithAd
- ManualUserInputDiscoverySourceId
DomainNameIndexCreateArgs:
description: DomainNameIndexCreateArgs
properties:
data:
$ref: '#/components/schemas/DomainNameIndexCreateModel'
type: object
PagingOfDomainNameIndexSummary:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/DomainNameIndexSummary'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
type: object
DomainNameIndexSummary:
description: Query results
properties:
discoverySourceId:
description: DiscoverySourceId
type: integer
format: int32
nullable: true
discoverySourceIdScanned:
description: DiscoverySourceIdScanned
type: integer
format: int32
nullable: true
discoverySourceIdSuggested:
description: DiscoverySourceIdSuggested
type: integer
format: int32
nullable: true
domainMarkedAsIgnored:
description: DomainMarkedAsIgnored
type: boolean
domainNameDiscovered:
description: DomainNameDiscovered
type: string
domainNameIndexId:
description: DomainNameIndexId
type: integer
format: int32
domainResolveType:
$ref: '#/components/schemas/DomainResolveType'
expiredDate:
description: ExpiredDate
type: string
format: date-time
nullable: true
lastIndexedDate:
description: LastIndexedDate
type: string
format: date-time
type: object
DomainNameIndexUpdateArgs:
description: DomainNameIndexUpdateArgs
properties:
data:
$ref: '#/components/schemas/DomainNameIndexUpdateModel'
type: object
DomainNameIndexUpdateModel:
description: Data
properties:
discoverySourceIdSuggested:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
domainMarkedAsIgnored:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
DomainNameIndexCreateModel:
description: Data
properties:
discoverySourceIdSuggested:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
domainMarkedAsIgnored:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
domainNameDiscovered:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
DomainNameIndexExpireUpdateModel:
description: Data
properties:
domainNameIndexId:
$ref: '#/components/schemas/UpdateFieldValueOfOptionalInt32'
reIndexNow:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
type: object
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
DomainNameIndexModel:
description: Domain Name Index
properties:
discoverySourceId:
description: DiscoverySourceId
type: integer
format: int32
nullable: true
discoverySourceIdScanned:
description: DiscoverySourceIdScanned
type: integer
format: int32
nullable: true
discoverySourceIdSuggested:
description: DiscoverySourceIdSuggested
type: integer
format: int32
nullable: true
domainMarkedAsIgnored:
description: Indicates if the domain is marked As Ignored
type: boolean
domainNameDiscovered:
description: Domain Name Discovered
type: string
domainNameIndexId:
description: Domain Name Index Id
type: integer
format: int32
domainResolveType:
$ref: '#/components/schemas/DomainResolveType'
expiredDate:
description: Expired date
type: string
format: date-time
nullable: true
lastIndexedDate:
description: The date the domain was last indexed
type: string
format: date-time
type: object
UpdateFieldValueOfString:
description: Description
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: string
type: object
DomainNameIndexExpireUpdateArgs:
description: DomainNameIndexExpireUpdateArgs
properties:
data:
$ref: '#/components/schemas/DomainNameIndexExpireUpdateModel'
type: object
securitySchemes:
BearerToken:
type: apiKey
description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
name: Authorization
in: header