---
title: "POST /udl/site"
method: POST
path: "/udl/site"
tags: ["Site"]
---

# POST /udl/site

`POST /udl/site`

## Request

- Base URL: `https://unifieddatalibrary.com`
- URL: `https://unifieddatalibrary.com/udl/site`
- Auth: none declared

Service operation to take a single Site as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

## Request body

- SiteIngest: Properties and characteristics of a site entity, such as an airbase, airfield, naval station, etc.
  - `id` string: Unique identifier of the record, auto-generated by the system.
  - `entity` EntityIngest: An entity is a generic representation of any object within a space/SSA system such as sensors, on-orbit objects, RF Emitters, spacecraft buses, etc. An entity can have an operating unit, a location (if terrestrial), and statuses.
    - `idEntity` string: Unique identifier of the record.
    - `name` string, required: Unique entity name.
    - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
    - `type` 'AIRCRAFT' | 'BUS' | 'COMM' | 'IR' | 'LASEREMITTER' | 'NAVIGATION' | 'ONORBIT' | 'RFEMITTER' | 'SCIENTIFIC' | 'SENSOR' | 'SITE' | 'VESSEL', required: The type of entity represented by this record (AIRCRAFT, BUS, COMM, IR, LASEREMITTER, NAVIGATION, ONORBIT, RFEMITTER, SCIENTIFIC, SENSOR, SITE, VESSEL).
    - `idLocation` string: Unique identifier of the entity location, if terrestrial/fixed.
    - `countryCode` string: The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.
    - `ownerType` 'Commercial' | 'Government' | 'Academic' | 'Consortium' | 'Other': Type of organization which owns this entity (e.g. Commercial, Government, Academic, Consortium, etc).
    - `taskable` boolean: Boolean indicating if this entity is taskable.
    - `urls` string[]: List of URLs to additional details/documents for this entity.
    - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
    - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
    - `source` string, required: Source of the data.
    - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.
    - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets.
    - `location` LocationIngest: Model representation of a location, which is a specific fixed point on the earth and is used to denote the locations of fixed sensors, operating units, etc.
      - `idLocation` string: Unique identifier of the location, auto-generated by the system.
      - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
      - `name` string, required: Location name.
      - `countryCode` string: The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.
      - `lat` number, double: WGS84 latitude of the location, in degrees. -90 to 90 degrees (negative values south of equator).
      - `lon` number, double: WGS84 longitude of the location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).
      - `altitude` number, double: Altitude of the location, in kilometers.
      - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
      - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
      - `source` string, required: Source of the data.
      - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.
      - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets.
      - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.
    - `onOrbit` object: Model object representing on-orbit objects or satellites in the system.
      - `idOnOrbit` string: For the public catalog, the idOnOrbit is typically the satellite number as a string, but may be a UUID for analyst or other unknown or untracked satellites, auto-generated by the system.
      - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
      - `satNo` integer, required: Satellite/Catalog number of the target on-orbit object.
      - `commonName` string: Common name of the on-orbit object.
      - `constellation` string: Constellation to which this satellite belongs.
      - `intlDes` string: International Designator, typically of the format YYYYLLLAAA, where YYYY is the launch year, LLL is the sequential launch number of that year, and AAA is an optional launch piece designator for the launch.
      - `launchDate` string, date: Date of launch.
      - `decayDate` string, date-time: Date of decay.
      - `objectType` 'ROCKET BODY' | 'DEBRIS' | 'PAYLOAD' | 'PLATFORM' | 'MANNED' | 'UNKNOWN': Type of on-orbit object: ROCKET BODY, DEBRIS, PAYLOAD, PLATFORM, MANNED, UNKNOWN.
      - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.
      - `missionNumber` string: Mission number of the on-orbit object.
      - `category` 'Unknown' | 'On-Orbit' | 'Decayed' | 'Cataloged Without State' | 'Launch Nominal' | 'Analyst Satellite' | 'Cislunar' | 'Lunar' | 'Hyperbolic' | 'Heliocentric' | 'Interplanetary' | 'Lagrangian' | 'Docked': Category of the on-orbit object. (Unknown, On-Orbit, Decayed, Cataloged Without State, Launch Nominal, Analyst Satellite, Cislunar, Lunar, Hyperbolic, Heliocentric, Interplanetary, Lagrangian, Docked).
      - `lifetimeYears` integer: Estimated lifetime of the on-orbit payload, if known.
      - `altName` string: Alternate name of the on-orbit object.
      - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
      - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
      - `source` string, required: Source of the data.
      - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets.
      - `launchSiteId` string: Id of the associated launchSite entity.
      - `countryCode` string: The country code. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.
      - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.
    - `idOnOrbit` string: Onorbit identifier if this entity is part of an on-orbit object. For the public catalog, the idOnOrbit is typically the satellite number as a string, but may be a UUID for analyst or other unknown or untracked satellites.
    - `idOperatingUnit` string: Unique identifier of the associated operating unit object.
    - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.
  - `idEntity` string: Unique identifier of the parent entity. idEntity is required for Put.
  - `idParentSite` string: Unique identifier of the Parent Site record associated with this Site record.
  - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
  - `origSiteID` string: Unique identifier of the Site record from the originating system.
  - `origLzId` string: Unique identifier of the LZ record from the originating system.
  - `pin` string: Site number of a specific electronic site or its associated equipment.
  - `type` string: The type of this site (AIRBASE, AIRFIELD, AIRPORT, NAVAL STATION, etc.).
  - `usage` string: The use authorization type of this site (e.g MILITARY, CIVIL, JOINT-USE, etc.).
  - `lzUsage` string: Indicates the normal usage of the Landing Zone (LZ). Intended as, but not constrained to MIDB Helocopter Landing Area usage value definitions: AF - Airfield FD - Field HC - High Crop. 1 meter and over. HY - Highway LB - Lake Bed LC - Low Crop. 0-1 meters O - Other. Explain In Remarks. PD - Paddy PK - Park PS - Pasture RB - Riverbed SP - Sport Field U - Unknown Z - Inconclusive Analysis.
  - `name` string, required: The name of this site.
  - `coordDatum` string: A mathematical model of the earth used to calculate coordinates on a map. US Forces use the World Geodetic System 1984 (WGS 84), but also use maps by allied countries with local datums. The datum must be specified to ensure accuracy of coordinates. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `coord` string: Indicates any of the magnitudes that serve to define the position of a point by reference to a fixed figure, system of lines, etc. Pos. 1-2. Latitude Degrees [00-90] Pos. 3-4. Latitude Minutes [00-59] Pos. 5-6. Latitude Seconds [00-59] Pos. 7-9. Latitude Thousandths Of Seconds [000-999] Pos. 10. Latitude Hemisphere [NS] Pos. 11-13. Longitude Degrees [00-180] Pos. 14-15. Longitude Minutes [00-59] Pos. 16-17. Longitude Seconds [00-59] Pos. 18-20. Longitude Thousandths Of Seconds [000-999] Pos. 21. Longitude Hemisphere [EW] Pos. 1-21. Unknown Latitude and Unknown Longitude [000000000U000000000U].
  - `coordDerivAcc` number, double: Indicates the plus or minus error assessed against the method used to derive the coordinate.
  - `osuffix` string: The O-suffix associated with this site. The O-suffix is a five-character alpha/numeric system used to identify a site, or demographic area, within an installation. The Installation Basic Encyclopedia (beNumber), in conjunction with the O-suffix, uniquely identifies the Site. The Installation beNumber and oSuffix are also used in conjunction with the catCode to classify the function or purpose of the facility.
  - `iata` string: The International Air Transport Association (IATA) code of this site, if applicable.
  - `icao` string: The International Civil Aviation Organization (ICAO) code of this site, if applicable.
  - `faa` string: The Federal Aviation Administration (FAA) Location ID of this site, if applicable.
  - `airDefArea` string: Air Defense District (ADD) or Air Defense Area (ADA) in which the geographic coordinates reside.
  - `utm` string: Universal Transverse Mercator (UTM) grid coordinates. Pos. 1-2, UTM Zone Column [01-60 Pos. 3, UTM Zone Row [C-HJ-NP-X] Pos. 4, UTM False Easting [0-9] Pos. 5-9, UTM Meter Easting [0-9][0-9][0-9][0-9][0-9] Pos. 10-11, UTM False Northing [0-9][0-9] Pos. 12-16, UTM Meter Northing [0-9][0-9][0-9][0-9][0-9].
  - `milGridSys` string: Indicates the grid system used in the development of the milGrid coordinates. Values are: UPS - Universal Polar System UTM - Universal Transverse Mercator.
  - `milGrid` string: The Military Grid Reference System is the geocoordinate standard used by NATO militaries for locating points on Earth. The MGRS is derived from the Universal Transverse Mercator (UTM) grid system and the Universal Polar Stereographic (UPS) grid system, but uses a different labeling convention. The MGRS is used as geocode for the entire Earth. Example of an milgrid coordinate, or grid reference, would be 4QFJ12345678, which consists of three parts: 4Q (grid zone designator, GZD) FJ (the 100,000-meter square identifier) 12345678 (numerical location; easting is 1234 and northing is 5678, in this case specifying a location with 10 m resolution).
  - `catCode` string: The category code that represents the associated site purpose within the target system.
  - `catText` string: Textual Description of Site catCode.
  - `wac` string: World Aeronautical Chart identifier for the area in which a designated place is located.
  - `polSubdiv` string: Political subdivision in which the geographic coordinates reside. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `geoArea` string: Geographical region code used by the Requirements Management System (RMS) as specified by National Geospatial Agency (NGA) in Flight Information Publications (FIPS) 10-4, Appendix 3 - Country Code and Geographic Region Codes. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `geoidalMslSep` number, double: The distance between Mean Sea Level and a referenced ellipsoid, in meters.
  - `allegiance` string: The DoD Standard Country Code designator for the country or political entity to which the site owes its allegiance. This field will be set to "OTHR" if the source value does not match a UDL Country code value (ISO-3166-ALPHA-2).
  - `altAllegiance` string: Specifies an alternate allegiance code if the data provider code is not part of an official Country Code standard such as ISO-3166 or FIPS. This field will be set to the value provided by the source and should be used for all Queries specifying allegiance.
  - `classRating` string: Indicates the importance of the entity to the OES or MIR system. This data element is restricted to update by DIA (DB-4). Valid values are: 0 - Does not meet criteria above 1 - Primary importance to system 2 - Secondary importance to system 3 - Tertiary importance to system O - Other. Explain in Remarks.
  - `fpa` string: Functional Production Area (FPA) under the Shared Production Program (SPP). Producers are defined per country per FPA. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `beNumber` string: The Basic Encyclopedia Number associated with the Site. Uniquely identifies the installation of a site. The beNumber is generated based on the value input for the COORD to determine the appropriate World Aeronautical Chart (WAC) location identifier, the system assigned record originator and a one-up-number.
  - `runways` integer: The number of runways at the site, if applicable.
  - `maxRunwayLength` integer: The length of the longest runway at this site, if applicable, in meters.
  - `condition` string: The physical manner of being or state of existence of the entity. A physical condition that must be considered in the determining of a course of action. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `conditionAvail` string: Availability of the entity relative to its condition. Indicates the reason the entity is not fully operational. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `operStatus` string: The Degree to which an entity is ready to perform the overall operational mission(s) for which it was organized and equipped. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `grade` integer: Indicates the amount or degree of deviation from the horizontal represented as a percent. Grade is determined by the formula: vertical distance (VD) divided by horizontal distance (HD) times 100. VD is the difference between the highest and lowest elevation within the entity. HD is the linear distance between the highest and lowest elevation.
  - `activity` string: Indicates the function or mission of an entity, which that entity may or may not be engaged in at any particular time. Typically refers to a unit, organization, or installation/site performing a specific function or mission such as a redistribution center or naval shipyard. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `functPrimary` string: Principal operational function being performed. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `msnPrimary` string: Indicates the principal type of mission that an entity is organized and equipped to perform. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `msnPrimarySpec` string: Indicates the principal specialty type of mission that an entity is organized and equipped to perform. The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `nucCap` string: A sites ability to conduct nuclear warfare. Valid Values are: A - Nuclear Ammo Or Warheads Available N - No Nuclear Offense O - Other. Explain in Remarks U - Unknown W - Nuclear Weapons Available Y - Nuclear Warfare Offensive Capability Z - Inconclusive Analysis.
  - `ident` string: Estimated identity of the Site (ASSUMED FRIEND, FRIEND, HOSTILE, FAKER, JOKER, NEUTRAL, PENDING, SUSPECT, UNKNOWN): ASSUMED FRIEND: Track assumed to be a friend due to the object characteristics, behavior, and/or origin. FRIEND: Track object supporting friendly forces and belonging to a declared friendly nation or entity. HOSTILE: Track object belonging to an opposing nation, party, group, or entity deemed to contribute to a threat to friendly forces or their mission due to its behavior, characteristics, nationality, or origin. FAKER: Friendly track, object, or entity acting as an exercise hostile. JOKER: Friendly track, object, or entity acting as an exercise suspect. NEUTRAL: Track object whose characteristics, behavior, nationality, and/or origin indicate that it is neither supporting nor opposing friendly forces or their mission. PENDING: Track object which has not been evaluated. SUSPECT: Track object deemed potentially hostile due to the object characteristics, behavior, nationality, and/or origin. UNKNOWN: Track object which has been evaluated and does not meet criteria for any standard identity.
  - `elevMsl` number, double: Ground elevation of the geographic coordinates referenced to (above or below) Mean Sea Level (MSL) vertical datum, in meters.
  - `elevMslConfLvl` integer: Indicates the confidence level expressed as a percent that a specific geometric spatial element, ELEVATION_MSL linear accuracy, has been vertically positioned to within a specified vertical accuracy.
  - `elevMslDerivAcc` number, double: Indicates the plus or minus error assessed against the method used to derive the elevation.
  - `vegHt` number, double: Maximum expected height of the vegetation in the Landing Zone (LZ), in meters.
  - `vegType` string: The predominant vegetation found in the Landing Zone (LZ). The specific usage and enumerations contained in this field may be found in the documentation provided in the referenceDoc field. If referenceDoc not provided, users may consult the data provider.
  - `popArea` boolean: Indicates whether the facility is in or outside of a populated area. True, the facility is in or within 5 NM of a populated area. False, the facility is outside a populated area.
  - `popAreaProx` number, double: Indicates the distance to nearest populated area (over 1,000 people) in nautical miles.
  - `notes` string: Optional notes/comments for the site.
  - `resProd` string: Responsible Producer - Organization that is responsible for the maintenance of the record.
  - `eval` integer: Eval represents the Intelligence Confidence Level or the Reliability/degree of confidence that the analyst has assigned to the data within this record. The numerical range is from 1 to 9 with 1 representing the highest confidence level.
  - `reviewDate` string, date: Date on which the data in the record was last reviewed by the responsible analyst for accuracy and currency, in ISO8601 UTC format. This date cannot be greater than the current date.
  - `recStatus` string: Validity and currency of the data in the record to be used in conjunction with the other elements in the record as defined by SOPs. A - Active I - Inactive K - Acknowledged L - Local Q - A nominated (NOM) or Data Change Request (DCR) record R - Production reduced by CMD decision W - Working Record.
  - `symCode` string: A standard scheme for symbol coding enabling the transfer, display and use of symbols and graphics among information systems, as per MIL-STD 2525B, and supported by the element ident.
  - `referenceDoc` string: The reference documentation that specifies the usage and enumerations contained in this record. If referenceDoc not provided, users may consult the data provider.
  - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
  - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
  - `source` string, required: Source of the data.
  - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.
  - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.
  - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

## Response `201`

Success

## Other responses

- `400`: Bad Request
- `401`: Invalid/Missing User Credentials
- `403`: User Is Not Authorized
- `405`: Method Not Allowed
- `415`: MediaType Unsupported
- `429`: Rate of Requests Exceeds Allowed Limit
- `500`: Internal Server Error

## Changes

> 12 revisions in range; 1 could not be searched.

- **2025-05-29** `4e1cbc17e814`: 1 info
  - added the new `LASEREMITTER` enum value to the request property `entity/type`
- **2025-04-16** `75f764c843a9`: 1 breaking, 2 warning, 2 info
  - the `runways` request property format changed from `int32` to `int16`
  - the `entity/onOrbit/countryCode` request property's maxLength was set to `4`
  - the `entity/onOrbit/satNo` request property's min was set to `0.00`
  - api operation id `create_113` removed and replaced with ``
  - …1 more

[Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/site/post.md)

---

[API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)